New "bookmark" plugin allows hotkey fast-travel to specific steps #852
+146
−14
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Bookmark | ||
|
|
||
| Nonlinear navigation similar to the Goto plugin. | ||
|
|
||
| Goto supports nonlinear navigation by *locally* defining *out-links*, accessible via the arrow keys. | ||
|
|
||
| Bookmark supports nonlinear navigation by *globally* defining *in-links*, accessible via normal keys like 1,2,3,A,B,C. | ||
|
|
||
| Example: | ||
|
|
||
| ```html | ||
| <!-- data-bookmark-key-list allows an "inbound"-oriented style of non-linear navigation. --> | ||
| <div id="..." class="step" data-bookmark-key-list="Digit1 KeyA 1 2 3 a b c"> | ||
| ``` | ||
|
|
||
| An `id` is required on the `div`. | ||
|
|
||
| If you assign the same key to multiple steps, that hotkey will cycle among them. | ||
|
|
||
| WARNING: It's up to you to avoid reserved hotkeys H, B, P, ?, etc. | ||
|
|
||
| Author | ||
| ------ | ||
|
|
||
| Copyright 2023 Wong Meng Weng (@mengwong) | ||
| Released under the MIT license. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /** | ||
| * Bookmark Plugin | ||
| * | ||
| * The bookmark plugin consists of | ||
| * a pre-init plugin, | ||
| * a keyup listener, and | ||
| * a pre-stepleave plugin. | ||
| * | ||
| * The pre-init plugin surveys all step divs to set up bookmark keybindings. | ||
| * The pre-stepleave plugin alters the destination when a bookmark hotkey is pressed. | ||
| * | ||
| * Example: | ||
| * | ||
| * <!-- data-bookmark-key-list allows an "inbound" style of non-linear navigation. --> | ||
| * <div id="..." class="step" data-bookmark-key-list="Digit1 KeyA 1 2 3 a b c"> | ||
| * | ||
| * See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values for a table | ||
| * of what strings to use for each key. Both .key and .code styles are recognized. | ||
| * | ||
| * It's up to the HTML author to avoid reserved hotkeys H, B, P, ? etc. | ||
| * | ||
| * Copyright 2016-2017 Henrik Ingo (@henrikingo) | ||
|
Contributor
There was a problem hiding this comment. You can credit yourself here as well! |
||
| * Released under the MIT license. | ||
| */ | ||
| /* global document, impress */ | ||
|
|
||
| ( function( document ) { | ||
| "use strict"; | ||
| var hotkeys = {}; | ||
| function hotkeyDest( event ) { | ||
| return ( hotkeys.hasOwnProperty( event.key ) ? hotkeys[ event.key ] : | ||
| hotkeys.hasOwnProperty( event.code ) ? hotkeys[ event.code ] : null ); } | ||
|
|
||
| // In pre-init phase, build a map of bookmark hotkey to div id, by reviewing all steps | ||
| impress.addPreInitPlugin( function( root, api ) { | ||
| root.querySelectorAll( ".step" ).forEach( function( div ) { | ||
| if ( div.dataset.bookmarkKeyList !== undefined && div.id !== undefined ) { | ||
| div.dataset.bookmarkKeyList.split( " " ).forEach( ( k ) => { | ||
| if ( hotkeys.hasOwnProperty( k ) ) { | ||
| hotkeys[ k ].push( div.id ); | ||
| } else { hotkeys[ k ] = [ div.id ]; } } ); } } ); | ||
|
Contributor
There was a problem hiding this comment. Can you move those closing brackets to separate lines? This makes the code more legible for beginners, imo. Also some explanation might be needed for the code here, if someone with less coding (well js, anyway) knowledge than you have reads this code.
Contributor
Author
There was a problem hiding this comment. lol i'm surprised the linter even let me do that … haha I don't really think there's anything to be gained from adding a bunch of punctuation over multiple lines… my preference is to keep things as short as possible so you can see everything on one screen. They used to say "you can write Fortran in any language", now I suppose they should say "you can write Python in any language" 😺
Contributor
There was a problem hiding this comment. The linter is not properly configured for that. I have an issue open to talk about moving to eslint and how to configure it |
||
|
|
||
| api.lib.gc.addEventListener( document, "keyup", function( event ) { | ||
| if ( hotkeyDest( event ) !== null ) { | ||
| event.stopImmediatePropagation(); | ||
| api.next( event ); | ||
|
|
||
| // Event.preventDefault(); | ||
| } | ||
| } ); | ||
| } ); | ||
|
|
||
| // In pre-stepleave phase, match a hotkey and reset destination accordingly. | ||
| impress.addPreStepLeavePlugin( function( event ) { | ||
|
|
||
| // Window.console.log(`bookmark: running as PreStepLeavePlugin; event=`); | ||
| // window.console.log(event) | ||
| if ( ( !event || !event.origEvent ) ) { return; } | ||
| var dest = hotkeyDest( event.origEvent ); | ||
| if ( dest ) { | ||
|
|
||
| // Window.console.log(`bookmark: recognizing hotkey ${event.code} goes to ${dest}`) | ||
|
Contributor
There was a problem hiding this comment. Do you really want to leave the debug code commented out in here?
Contributor
Author
There was a problem hiding this comment. i have taken it out, will push a new rev. Still working on the test failure. |
||
| var newTarget = document.getElementById( dest[ 0 ] ); // jshint ignore:line | ||
| if ( newTarget ) { | ||
| event.detail.next = newTarget; | ||
| dest.push( dest.shift() ); // Repeated hotkey presses cycle through each dest. | ||
| } | ||
| } | ||
| } ); | ||
|
|
||
| } )( document ); | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couldn't you just disallow the usage of those keys?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't think so, it would clobber the other plugins … I'll think about how to resolve the interaction effects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is ok. If you want to override a reserved key, just do it.