Add vim key bindings for navigation #3072
+22
−1
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -718,6 +718,7 @@ | |
| } | ||
|
|
||
| switch (e.key) { | ||
| case 'l': | ||
| case 'ArrowRight': | ||
| e.preventDefault(); | ||
| if (html.dir === 'rtl') { | ||
|
|
@@ -726,6 +727,7 @@ | |
| next(); | ||
| } | ||
| break; | ||
| case 'h': | ||
| case 'ArrowLeft': | ||
| e.preventDefault(); | ||
| if (html.dir === 'rtl') { | ||
|
|
@@ -734,6 +736,22 @@ | |
| prev(); | ||
| } | ||
| break; | ||
| case 'j': | ||
| e.preventDefault(); | ||
| window.scrollBy({ top: 80, behavior: 'smooth' }); | ||
| break; | ||
| case 'k': | ||
| e.preventDefault(); | ||
| window.scrollBy({ top: -80, behavior: 'smooth' }); | ||
| break; | ||
| case 'd': | ||
| e.preventDefault(); | ||
| window.scrollBy({ top: window.innerHeight, behavior: 'smooth' }); | ||
| break; | ||
| case 'u': | ||
| e.preventDefault(); | ||
| window.scrollBy({ top: -window.innerHeight, behavior: 'smooth' }); | ||
| break; | ||
|
Comment on lines
+739
to
+754
There was a problem hiding this comment. The scroll behavior is duplicated across four cases and introduces a magic number ( |
||
| } | ||
| }); | ||
| })(); | ||
|
|
||
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -67,7 +67,8 @@ | |||||
| <div id="mdbook-help-popup"> | ||||||
| <h2 class="mdbook-help-title">Keyboard shortcuts</h2> | ||||||
| <div> | ||||||
| <p>Press <kbd>←</kbd>/<kbd>→</kbd> or <kbd>h</kbd>/<kbd>l</kbd> to navigate between chapters</p> | ||||||
| <p>Press <kbd>j</kbd>/<kbd>k</kbd> or <kbd>d</kbd>/<kbd>u</kbd> to scroll the page up and down</p> | ||||||
|
There was a problem hiding this comment. The second line lumps
Suggested change
|
||||||
| {{#if search_enabled}} | ||||||
| <p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p> | ||||||
| {{/if}} | ||||||
|
|
||||||
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -23,6 +23,8 @@ The **arrow buttons** at the bottom of the page can be used to navigate to the p | |||||
|
|
||||||
| The **left and right arrow keys** on the keyboard can be used to navigate to the previous or the next chapter. | ||||||
|
|
||||||
| Additionally, Vim-style key bindings (<kbd>H</kbd>, <kbd>J</kbd>, <kbd>K</kbd>, <kbd>L</kbd>, <kbd>D</kbd> and <kbd>U</kbd>) can be used for navigation. | ||||||
|
There was a problem hiding this comment. This line says the Vim-style keys are used for “navigation”, but in the implementation
Suggested change
|
||||||
|
|
||||||
| ## Top menu bar | ||||||
|
|
||||||
| The menu bar at the top of the page provides some icons for interacting with the book. | ||||||
|
|
||||||
Oops, something went wrong.
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.
These scroll actions always use
behavior: 'smooth'. For users who prefer reduced motion, this can be an accessibility issue. Consider detectingprefers-reduced-motion: reduceand usingbehavior: 'auto'(or omittingbehavior) when reduced motion is requested.