aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMario Botsch <botsch@techfak.uni-bielefeld.de>2019-04-23 23:28:05 +0200
committerMario Botsch <botsch@techfak.uni-bielefeld.de>2019-04-23 23:28:05 +0200
commit1f5fb971d4a6cf6ab153a2484a440f80e24a1400 (patch)
tree611d0a13d84029dd8ec59fcbfcfe8b3505fafa7a /README.md
parenta16b71a981e9385627959273bb4e910e1d502c92 (diff)
downloadfosdem-2021-minimalism-presentation-1f5fb971d4a6cf6ab153a2484a440f80e24a1400.tar
fosdem-2021-minimalism-presentation-1f5fb971d4a6cf6ab153a2484a440f80e24a1400.tar.gz
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 65f9332..2e0f48f 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