Browse Source

Merge pull request #1816 from Frazer/patch-1

added toggleHelp function
Hakim El Hattab 7 years ago
parent
commit
1749f0d019
1 changed files with 25 additions and 6 deletions
  1. 25 6
      js/reveal.js

+ 25 - 6
js/reveal.js

@@ -1633,6 +1633,29 @@
 
 	}
 
+	/**
+	 * Open or close help overlay window.
+	 *
+	 * @param {Boolean} [override] Flag which overrides the
+	 * toggle logic and forcibly sets the desired state. True means
+	 * help is open, false means it's closed.
+	 */
+	function toggleHelp( override ){
+		
+		if( typeof override === 'boolean' ) {
+			override ? showHelp( true ) : closeOverlay();
+		}
+		else {		
+			if( dom.overlay ) {
+				closeOverlay();
+			}
+			else {
+				showHelp( true );
+			}
+		}
+	}
+
+	
 	/**
 	 * Opens an overlay window with help material.
 	 */
@@ -4157,12 +4180,7 @@
 
 		// Check if the pressed key is question mark
 		if( event.shiftKey && event.charCode === 63 ) {
-			if( dom.overlay ) {
-				closeOverlay();
-			}
-			else {
-				showHelp( true );
-			}
+			toggleHelp();
 		}
 
 	}
@@ -4862,6 +4880,7 @@
 
 		// Shows a help overlay with keyboard shortcuts
 		showHelp: showHelp,
+		toggleHelp: toggleHelp,
 
 		// Forces an update in slide layout
 		layout: layout,