From 7297474b2e683f6e6e382891b2ec36e7f22c0764 Mon Sep 17 00:00:00 2001
From: Greg Denehy
Date: Sun, 30 Apr 2017 15:23:04 +0930
Subject: Added programatic support for custom key bindings with optional
descriptions to be added to the help screen
---
js/reveal.js | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 69 insertions(+), 2 deletions(-)
(limited to 'js/reveal.js')
diff --git a/js/reveal.js b/js/reveal.js
index e25337e..e8833c4 100644
--- a/js/reveal.js
+++ b/js/reveal.js
@@ -232,7 +232,10 @@
'B , .': 'Pause',
'F': 'Fullscreen',
'ESC, O': 'Slide overview'
- };
+ },
+
+ // Holds custom key code mappings
+ registeredKeyBindings = {};
/**
* Starts up the presentation if the client is capable.
@@ -1091,6 +1094,33 @@
}
+ /**
+ * Add a custom key binding with optional description to be added to the help screen
+ */
+ function addKeyBinding(binding, callback) {
+ if (typeof binding === 'object' && binding.code) {
+ registeredKeyBindings[binding.code] = {
+ callback: callback,
+ key: binding.key,
+ description: binding.description
+ }
+ }
+ else {
+ registeredKeyBindings[binding] = {
+ callback: callback,
+ key: null,
+ description: null
+ }
+ }
+ }
+
+ /**
+ * Removes the specified custom key binding
+ */
+ function removeKeyBinding(binding) {
+ delete registeredKeyBindings[binding];
+ }
+
/**
* Extend object a with the properties of object b.
* If there's a conflict, object b takes precedence.
@@ -1518,6 +1548,13 @@
html += '| ' + key + ' | ' + keyboardShortcuts[ key ] + ' |
';
}
+ // add custom key bindings that have associated descriptions
+ for( var binding in registeredKeyBindings ) {
+ if (registeredKeyBindings[binding].key && registeredKeyBindings[binding].description) {
+ html += '| ' + registeredKeyBindings[binding].key + ' | ' + registeredKeyBindings[binding].description + ' |
';
+ }
+ }
+
html += '';
dom.overlay.innerHTML = [
@@ -3967,7 +4004,31 @@
}
- // 2. System defined key bindings
+ // 2. Registered custom key bindings
+ if( triggered === false ) {
+
+ for( key in registeredKeyBindings ) {
+
+ // Check if this binding matches the pressed key
+ if( parseInt( key, 10 ) === event.keyCode ) {
+
+ var value = registeredKeyBindings[ key ].callback;
+
+ // Callback function
+ if( typeof value === 'function' ) {
+ value.apply( null, [ event ] );
+ }
+ // String shortcuts to reveal.js API
+ else if( typeof value === 'string' && typeof Reveal[ value ] === 'function' ) {
+ Reveal[ value ].call();
+ }
+
+ triggered = true;
+ }
+ }
+ }
+
+ // 3. System defined key bindings
if( triggered === false ) {
// Assume true and try to prove false
@@ -4676,6 +4737,12 @@
}
},
+ // Adds a custom key binding
+ addKeyBinding: addKeyBinding,
+
+ // Removes a custom key binding
+ removeKeyBinding: removeKeyBinding,
+
// Programatically triggers a keyboard event
triggerKey: function( keyCode ) {
onDocumentKeyDown( { keyCode: keyCode } );
--
cgit v1.2.3
From 8bf9986fa21c89b9b38145b43e6fe572c3acebd5 Mon Sep 17 00:00:00 2001
From: Greg Denehy
Date: Sun, 30 Apr 2017 15:24:42 +0930
Subject: Pass through key event when calling keyboardCondition() to allow
conditional function to filter on key codes
---
js/reveal.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'js/reveal.js')
diff --git a/js/reveal.js b/js/reveal.js
index e8833c4..9d4444f 100644
--- a/js/reveal.js
+++ b/js/reveal.js
@@ -3940,7 +3940,7 @@
// If there's a condition specified and it returns false,
// ignore this event
- if( typeof config.keyboardCondition === 'function' && config.keyboardCondition() === false ) {
+ if( typeof config.keyboardCondition === 'function' && config.keyboardCondition(event) === false ) {
return true;
}
--
cgit v1.2.3
From e48e1e19b97d99de107966dd3f8c431a89457972 Mon Sep 17 00:00:00 2001
From: Greg Denehy
Date: Sun, 30 Apr 2017 16:35:35 +0930
Subject: Changed custom key binding config properties to use 'keyCode' instead
of 'code'
---
js/reveal.js | 4 ++--
plugin/notes/notes.js | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
(limited to 'js/reveal.js')
diff --git a/js/reveal.js b/js/reveal.js
index 9d4444f..328edb0 100644
--- a/js/reveal.js
+++ b/js/reveal.js
@@ -1098,8 +1098,8 @@
* Add a custom key binding with optional description to be added to the help screen
*/
function addKeyBinding(binding, callback) {
- if (typeof binding === 'object' && binding.code) {
- registeredKeyBindings[binding.code] = {
+ if (typeof binding === 'object' && binding.keyCode) {
+ registeredKeyBindings[binding.keyCode] = {
callback: callback,
key: binding.key,
description: binding.description
diff --git a/plugin/notes/notes.js b/plugin/notes/notes.js
index 8980fb4..6373d97 100644
--- a/plugin/notes/notes.js
+++ b/plugin/notes/notes.js
@@ -106,7 +106,7 @@ var RevealNotes = (function() {
}
// Open the notes when the 's' key is hit
- Reveal.addKeyBinding({code: 83, key: 'S', description: 'Speaker notes'}, openNotes);
+ Reveal.addKeyBinding({keyCode: 83, key: 'S', description: 'Speaker notes'}, openNotes);
}
--
cgit v1.2.3
From b86b667d2552b32dd0a6d52a210fcf6bbb132867 Mon Sep 17 00:00:00 2001
From: Greg Denehy
Date: Sun, 30 Apr 2017 19:42:45 +0930
Subject: Changes to fix failed jshint test related to Key Binding API
---
js/reveal.js | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
(limited to 'js/reveal.js')
diff --git a/js/reveal.js b/js/reveal.js
index 4e44b01..0bdcd12 100644
--- a/js/reveal.js
+++ b/js/reveal.js
@@ -1234,14 +1234,14 @@
callback: callback,
key: binding.key,
description: binding.description
- }
+ };
}
else {
registeredKeyBindings[binding] = {
callback: callback,
key: null,
description: null
- }
+ };
}
}
@@ -4386,15 +4386,15 @@
// Check if this binding matches the pressed key
if( parseInt( key, 10 ) === event.keyCode ) {
- var value = registeredKeyBindings[ key ].callback;
+ var action = registeredKeyBindings[ key ].callback;
// Callback function
- if( typeof value === 'function' ) {
- value.apply( null, [ event ] );
+ if( typeof action === 'function' ) {
+ action.apply( null, [ event ] );
}
// String shortcuts to reveal.js API
- else if( typeof value === 'string' && typeof Reveal[ value ] === 'function' ) {
- Reveal[ value ].call();
+ else if( typeof action === 'string' && typeof Reveal[ action ] === 'function' ) {
+ Reveal[ action ].call();
}
triggered = true;
--
cgit v1.2.3