campiaperti/infra
1
0
Fork 1
Code Issues Pull requests 1 Releases Wiki Activity

docs for #1816 and remove showHelp

Browse source
This commit is contained in:
Hakim El Hattab 2017-02-09 11:37:47 +01:00
parent 1749f0d019
commit 5ad66f3779
2 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -466,14 +466,15 @@ Reveal.nextFragment();
// Randomize the order of slides // Randomize the order of slides
Reveal.shuffle(); Reveal.shuffle();
// Shows a help overlay with keyboard shortcuts
Reveal.showHelp();
// Toggle presentation states, optionally pass true/false to force on/off // Toggle presentation states, optionally pass true/false to force on/off
Reveal.toggleOverview(); Reveal.toggleOverview();
Reveal.togglePause(); Reveal.togglePause();
Reveal.toggleAutoSlide(); Reveal.toggleAutoSlide();
// Shows a help overlay with keyboard shortcuts, optionally pass true/false
// to force on/off
Reveal.toggleHelp();
// Change a config value at runtime // Change a config value at runtime
Reveal.configure({ controls: true }); Reveal.configure({ controls: true });

16
js/reveal.js
View file

@ -1641,21 +1641,20 @@
* help is open, false means it's closed. * help is open, false means it's closed.
*/ */
function toggleHelp( override ){ function toggleHelp( override ){
if( typeof override === 'boolean' ) { if( typeof override === 'boolean' ) {
override ? showHelp( true ) : closeOverlay(); override ? showHelp() : closeOverlay();
} }
else { else {
if( dom.overlay ) { if( dom.overlay ) {
closeOverlay(); closeOverlay();
} }
else { else {
showHelp( true ); showHelp();
} }
} }
} }
/** /**
* Opens an overlay window with help material. * Opens an overlay window with help material.
*/ */
@ -4878,10 +4877,6 @@
navigatePrev: navigatePrev, navigatePrev: navigatePrev,
navigateNext: navigateNext, navigateNext: navigateNext,
// Shows a help overlay with keyboard shortcuts
showHelp: showHelp,
toggleHelp: toggleHelp,
// Forces an update in slide layout // Forces an update in slide layout
layout: layout, layout: layout,
@ -4894,6 +4889,9 @@
// Returns an object with the available fragments as booleans (prev/next) // Returns an object with the available fragments as booleans (prev/next)
availableFragments: availableFragments, availableFragments: availableFragments,
// Toggles a help overlay with keyboard shortcuts
toggleHelp: toggleHelp,
// Toggles the overview mode on/off // Toggles the overview mode on/off
toggleOverview: toggleOverview, toggleOverview: toggleOverview,