From b61a6a6f104147e77a911d8d7565731531c23f0f Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Sun, 26 Apr 2020 08:29:15 +0200 Subject: [PATCH] rearrange plugins/dependencies --- README.md | 124 +++++++++++++++++++++++++++--------------------------- 1 file changed, 63 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 2f55cd6d..6ac29e6f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ This project was started and is maintained by [@hakimel](https://github.com/haki - [Initialization](#initialization) - [Configuration](#configuration) - [Presentation Size](#presentation-size) -- [Dependencies](#dependencies) - [Ready Event](#ready-event) - [Auto-Slide](#auto-slide) - [Auto-Animate](#auto-animate) @@ -26,6 +25,8 @@ This project was started and is maintained by [@hakimel](https://github.com/haki - [Vertical Slide Navigation](#vertical-slide-navigation) - [Touch Navigation](#touch-navigation) - [Lazy Loading](#lazy-loading) +- [Plugins](#plugins) +- [Dependencies](#dependencies) - [API](#api) - [Custom Key Bindings](#custom-key-bindings) - [Slide Change Events](#slide-change-events) @@ -56,7 +57,6 @@ This project was started and is maintained by [@hakimel](https://github.com/haki - [Server Side Speaker Notes](#server-side-speaker-notes) - [Multiplexing](#multiplexing) - [MathJax](#mathjax) -- [Plugins](#plugins) - [License](#license) #### More reading @@ -447,41 +447,6 @@ Reveal.initialize({ }); ``` -### Dependencies - -Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example: - -```javascript -Reveal.initialize({ - dependencies: [ - // Interpret Markdown in
elements - { src: 'plugin/markdown/marked.js', condition: () => { return !!document.querySelector( '[data-markdown]' ); } }, - { src: 'plugin/markdown/markdown.js', condition: () => { return !!document.querySelector( '[data-markdown]' ); } }, - - // Syntax highlight for elements - { src: 'plugin/highlight/highlight.js', async: true }, - - // Zoom in and out with Alt+click - { src: 'plugin/zoom-js/zoom.js', async: true }, - - // Speaker notes - { src: 'plugin/notes/notes.js', async: true }, - - // MathJax - { src: 'plugin/math/math.js', async: true } - ] -}); -``` - -You can add your own extensions using the same syntax. The following properties are available for each dependency object: -- **src**: Path to the script to load -- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false -- **callback**: [optional] Function to execute when the script has loaded -- **condition**: [optional] Function which must return true for the script to be loaded - -You can also include dependencies which are bundled/already present on the page. To include a bundled plugin. replace the `src` property with a reference to a `plugin` instance: -- **plugin**: the plugin instance (see [Plugins](#plugins)) - ### Ready Event A `ready` event is fired when reveal.js has loaded all non-async dependencies and is ready to start navigating. To check if reveal.js is already 'ready' you can call `Reveal.isReady()`. @@ -658,6 +623,67 @@ You can also change the default globally with the `preloadIframes` configuration regardless of individual `data-preload` attributes. If set to `false`, all iframes will only be loaded when they become visible. +### Plugins + +Plugins should register themselves with reveal.js by calling `Reveal.registerPlugin( MyPlugin )`. Registered plugins _must_ expose a unique `id` property and can optionally expose an `init` function that reveal.js will call to initialize them. + +When reveal.js is booted up via `initialize()`, it will go through all registered plugins and invoke their `init` methods. If the `init` method returns a Promise, reveal.js will wait for that promise to be fulfilled before finishing the startup sequence and firing the [ready](#ready-event) event. Here’s an example of a plugin that does some asynchronous work before reveal.js can proceed: + +```javascript +let MyPlugin = { + id: ’my-plugin’, + init: deck => { + return new Promise( resolve => setTimeout( resolve, 3000 ) ) + } +}; +Reveal.initialize({ + plugins: [ MyPlugin ] +}).then( () => { + console.log( ’Three seconds later...’ ) +} ); +``` + +Note that reveal.js will *not* wait for init Promise fulfillment if the plugin is loaded as an [async dependency](#dependencies). If the plugin’s 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 + +If you want to check if a specific plugin is registered you can use the `Reveal.hasPlugin` method and pass in a plugin ID, for example: `Reveal.hasPlugin( ’myPlugin’ )`. If you want to retrieve a plugin instance you can use `Reveal.getPlugin( ’myPlugin’ )`. + +### Dependencies + +Reveal.js doesn’t _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example: + +```javascript +Reveal.initialize({ + dependencies: [ + // Interpret Markdown in
elements + { src: ’plugin/markdown/marked.js’, condition: () => { return !!document.querySelector( ’[data-markdown]’ ); } }, + { src: ’plugin/markdown/markdown.js’, condition: () => { return !!document.querySelector( ’[data-markdown]’ ); } }, + + // Syntax highlight for elements + { src: ’plugin/highlight/highlight.js’, async: true }, + + // Zoom in and out with Alt+click + { src: ’plugin/zoom-js/zoom.js’, async: true }, + + // Speaker notes + { src: ’plugin/notes/notes.js’, async: true }, + + // MathJax + { src: ’plugin/math/math.js’, async: true } + ] +}); +``` + +You can add your own extensions using the same syntax. The following properties are available for each dependency object: +- **src**: Path to the script to load +- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false +- **callback**: [optional] Function to execute when the script has loaded +- **condition**: [optional] Function which must return true for the script to be loaded + +You can also include dependencies which are bundled/already present on the page. To include a bundled plugin. replace the `src` property with a reference to a `plugin` instance: +- **plugin**: the plugin instance (see [Plugins](#plugins)) + ### API The `Reveal` object exposes a JavaScript API for controlling navigation and reading state: @@ -1441,30 +1467,6 @@ If you want to include math inside of a presentation written in Markdown you nee `$$ J(\theta_0,\theta_1) = \sum_{i=0} $$` ``` -## Plugins - -Plugins should register themselves with reveal.js by calling `Reveal.registerPlugin( MyPlugin )`. Registered plugins _must_ expose a unique `id` property and can optionally expose an `init` function that reveal.js will call to initialize them. - -When reveal.js is booted up via `initialize()`, it will go through all registered plugins and invoke their `init` methods. If the `init` method returns a Promise, reveal.js will wait for that promise to be fulfilled before finishing the startup sequence and firing the [ready](#ready-event) event. Here's an example of a plugin that does some asynchronous work before reveal.js can proceed: - -```javascript -let MyPlugin = { - id: 'myPlugin', - init: deck => new Promise( resolve => setTimeout( resolve, 3000 ) ) -}; -Reveal.initialize({ - dependencies: [ { plugin: MyPlugin } ] -}).then( () => { - console.log( 'Three seconds later...' ) -} ); -``` - -Note that reveal.js will *not* wait for init Promise fulfillment if the plugin is loaded as an [async dependency](#dependencies). If the plugin's 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 - -If you want to check if a specific plugin is registered you can use the `Reveal.hasPlugin` method and pass in a plugin ID, for example: `Reveal.hasPlugin( 'myPlugin' )`. If you want to retrieve a plugin instance you can use `Reveal.getPlugin( 'myPlugin' )`. - ## License MIT licensed