aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHakim El Hattab <hakim.elhattab@gmail.com>2013-12-21 17:16:51 +0100
committerHakim El Hattab <hakim.elhattab@gmail.com>2013-12-21 17:16:51 +0100
commit522632188587dc739ced875cf1195e5664cfb355 (patch)
treeed34830d78f869c671adff9bd15d3a045611ab56 /README.md
parent7bd01bdebd6246cdd39a24da1a5cf4af9e9eb3ca (diff)
parent4498e6e609bbd9cca098815bd5ecf0179be8dbf4 (diff)
downloadfreenode-live-2017-presentation-522632188587dc739ced875cf1195e5664cfb355.tar
freenode-live-2017-presentation-522632188587dc739ced875cf1195e5664cfb355.tar.gz
Merge branch 'autoslide-API-and-fragments' of https://github.com/rajgoel/reveal.js into dev
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index d8fa4b2..58c2a0b 100644
--- a/README.md
+++ b/README.md
@@ -266,15 +266,19 @@ Reveal.configure({
autoSlide: 5000
});
```
+When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
-When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
-
-You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
+You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute on individual sections or fragments:
```html
-<section data-autoslide="10000">This will remain on screen for 10 seconds</section>
+<section data-autoslide="2000">
+ <p>After 2 seconds the first fragment will be shown.</p>
+ <p class="fragment" data-autoslide="10000">After 10 seconds the next fragment will be shown.</p>
+ <p class="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p>
+</section>
```
+Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired.
### Keyboard Bindings
@@ -308,6 +312,7 @@ Reveal.prevFragment();
Reveal.nextFragment();
Reveal.toggleOverview();
Reveal.togglePause();
+Reveal.toggleAutoSlide();
// Retrieves the previous and current slide elements
Reveal.getPreviousSlide();
@@ -320,6 +325,7 @@ Reveal.isFirstSlide();
Reveal.isLastSlide();
Reveal.isOverview();
Reveal.isPaused();
+Reveal.isSliding(); // auto slide mode
```
### Ready Event