feat(docs): page through the guide with left/right arrow keys - #2984
Closed
AnayGarodia wants to merge 7 commits into
Closed
feat(docs): page through the guide with left/right arrow keys#2984AnayGarodia wants to merge 7 commits into
AnayGarodia wants to merge 7 commits into
Conversation
Add a small keyboard-nav script (wired via zensical extra_javascript) that maps ArrowLeft/ArrowRight to the previous/next footer links, matching the common paged-site pattern. A single document-level listener keeps working across instant navigation, looks up the current page's footer links on each key press, and ignores key presses while a modifier is held or a form field (e.g. the search box) is focused. Fixes maplibre#2788
Performance Comparison
|
CommanderStorm
requested changes
Jul 9, 2026
CommanderStorm
left a comment
CommanderStorm
left a comment
Member
There was a problem hiding this comment.
I tesed it and it does not page through the docs. Am I using it wrong?
CommanderStorm
marked this pull request as draft
July 9, 2026 09:16
Contributor
Author
|
weird, it pages fine on my end. built the docs fresh ( my hunch is zensical serve doesn't re-read the new can drop a short screen capture of it paging if that's easier. |
CommanderStorm
requested changes
Jul 10, 2026
CommanderStorm
left a comment
CommanderStorm
left a comment
Member
There was a problem hiding this comment.
Ok, I think I had something in the cache, can reproduce the buttons changing pages now, so it partially works now.
The search bar does not work anymore though...
Comment on lines
+4
to
+13
| function isTypingTarget(el) { | ||
| if (!el) { | ||
| return false; | ||
| } | ||
| if (el.isContentEditable) { | ||
| return true; | ||
| } | ||
| var tag = el.tagName; | ||
| return tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT'; | ||
| } |
Member
There was a problem hiding this comment.
this does not seem to work seme to quite work
The keydown handler only bailed when focus was in the search input, but arrowing through the search results moves focus onto a result link, so Left/Right got hijacked and navigated the page out from under the open search. Bail whenever the search overlay is open, keyed on the theme's own `#__search` toggle checkbox, so arrow-key handling stays with search.
Contributor
Author
|
good catch, reproduced and fixed. the bug was in the focus check. i only bailed when you were typing in the search box (activeElement is the input), but when you arrow down into the results the theme moves focus onto the result link - so activeElement is an now it bails whenever the search overlay is open at all, keyed on the theme's own verified against the real search UI in a local build:
on the zensical.toml suggestion: |
AnayGarodia
marked this pull request as ready for review
July 11, 2026 04:59
Contributor
Author
|
Marked ready. Re-verified the search-vs-paging interaction end to end in a fresh local build (
That covers the regression you hit (paging worked but search broke): the guard now keys on the theme's |
Member
|
No, does not work. Please actually test your work.. 
|
CommanderStorm
marked this pull request as draft
July 13, 2026 20:19
Member
|
Does not currently work I think, so lets close this PR for now. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Fixes #2788. Left/Right arrow keys now page through the guide via the footer prev/next links — a common paged-docs convenience.
How
A single document-level
keydownlistener mapsArrowLeft/ArrowRightto the existing footera.md-footer__link--prev/--nextanchors, wired throughextra_javascript. It survivesnavigation.instant, ignores modifier-key combos, and does nothing when a form field is focused.Testing
uvx zensical build→ "No issues found"; the script is emitted and referenced in the built HTML./installation/, ArrowRight →/run/, ArrowLeft → back to/installation/; with an input focused, ArrowRight did not navigate (guard works).