aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhakimel <hakim.elhattab@gmail.com>2013-01-21 12:45:52 -0500
committerhakimel <hakim.elhattab@gmail.com>2013-01-21 12:45:52 -0500
commitd489ec2f9ddddb9e502c3cccbfe277f84c22963b (patch)
tree54357e26797c651077c84dab97caaabeb2e3cc48 /README.md
parente62b0f8795408e042a86f654ea4636ab95894476 (diff)
downloadfreenode-live-2017-presentation-d489ec2f9ddddb9e502c3cccbfe277f84c22963b.tar
freenode-live-2017-presentation-d489ec2f9ddddb9e502c3cccbfe277f84c22963b.tar.gz
add overviewshown and overviewhidden events (closes #298)
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index d7bf4c8..b5f374f 100644
--- a/README.md
+++ b/README.md
@@ -256,7 +256,15 @@ Reveal.addEventListener( 'fragmenthidden', function( event ) {
### Overview mode
Press "Esc" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides,
-as if you were at 1,000 feet above your presentation.
+as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:
+
+```javascript
+Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } );
+Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );
+
+// Toggle the overview mode programmatically
+Reveal.toggleOverview();
+```
### Fullscreen mode
Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.