diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 24 insertions, 10 deletions
@@ -8,7 +8,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/ #### More reading in the Wiki: - [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history. - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own! -- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Changelog): Explanation of browser support and fallbacks. +- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks. ## rvl.io @@ -75,7 +75,8 @@ Reveal.initialize({ loop: false, // Number of milliseconds between automatically proceeding to the - // next slide, disabled when set to 0 + // next slide, disabled when set to 0, this value can be overwritten + // by using a data-autoslide attribute on your slides autoSlide: 0, // Enable slide navigation via mouse wheel @@ -85,7 +86,7 @@ Reveal.initialize({ rollingLinks: true, // Transition style - transition: 'default' // default/cube/page/concave/linear(2d) + transition: 'default' // default/cube/page/concave/zoom/linear/none }); ``` @@ -103,6 +104,8 @@ Reveal.initialize({ // Interpret Markdown in <section> elements { src: 'lib/js/data-markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, { src: 'lib/js/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, + // Zoom in and out with Alt+click + { src: 'plugin/zoom-js/zoom.js', condition: function() { return !!document.body.classList; } }, // Speaker notes support { src: 'plugin/speakernotes/client.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } }, { src: '/socket.io/socket.io.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } }, @@ -123,13 +126,13 @@ The Reveal class provides a minimal JavaScript API for controlling navigation an ```javascript // Navigation -Reveal.navigateTo( indexh, indexv ); -Reveal.navigateLeft(); -Reveal.navigateRight(); -Reveal.navigateUp(); -Reveal.navigateDown(); -Reveal.navigatePrev(); -Reveal.navigateNext(); +Reveal.slide( indexh, indexv ); +Reveal.left(); +Reveal.right(); +Reveal.up(); +Reveal.down(); +Reveal.prev(); +Reveal.next(); Reveal.toggleOverview(); // Retrieves the previous and current slide elements @@ -151,6 +154,16 @@ Reveal.addEventListener( 'somestate', function() { }, false ); ``` +### Ready event + +The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating. + +```javascript +Reveal.addEventListener( 'ready', function( event ) { + // event.currentSlide, event.indexh, event.indexv +} ); +``` + ### Slide change event An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes. @@ -232,3 +245,4 @@ You can change the appearance of the speaker notes by editing the file at `plugi MIT licensed Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se + |