From 1f5fb971d4a6cf6ab153a2484a440f80e24a1400 Mon Sep 17 00:00:00 2001 From: Mario Botsch Date: Tue, 23 Apr 2019 23:28:05 +0200 Subject: [PATCH] Fix plugin documentation Mention that reveal.js will wait for the Promise of a plugin's init() function only when the plugin is loaded non-async. The init functions of plugins that are loaded as async dependencies are called after reveal.js has dispatched the 'ready' event. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 65f93329..2e0f48fa 100644 --- a/README.md +++ b/README.md @@ -1268,6 +1268,7 @@ Reveal.addEventListener( 'ready', () => console.log( 'Three seconds later...' ) Reveal.initialize(); ``` +For plugins that are loaded as [dependencies](#dependencies), reveal.js will wait for the fullfillment of their init Promise only for the *non-async* plugins. If the init method does _not_ return a Promise, the plugin is considered ready right away and will not hold up the reveal.js startup sequence. ### Retrieving Plugins