Use ALT+S to trigger search #1101
Closed
Conversation
This file contains 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
As currently implemented, any time the S key is pressed outside of the search interface, that keystroke is intercepted and the search interface is displayed. This causes problems when interactive widgets are embedded on the page (as raised in #1020). This PR instead switches to ALT+S so that interactive widgets can be displayed on the page (and more generally, makes the S key available to JavaScript running on the page). Rationale for ALT+S: * Current implementation uses 'S' -- so we want to stay close to that * 'S' is a great mnemonic device for _search_ * Windows desktop applications uses CTRL+S for save, which would likely cause the page to be downloaded * MacOS desktop applications use CMD+S (or `event.keyMeta` in javascript) to save * Ubuntu follows one of these conventions (can't remember which offhand...maybe both?) * ALT+S appears not to be in widespread usage on either of those platforms * ALT+S is only key-stroke different than current implementation
|
Thanks for the PR! I don't think we can make this change, because Alt-S is used on Windows to access menus. I imagine we could make this a configuration option. Even better: is it possible to disable/override the |
|
My pleasure!! Yes configuration option would be much better.
Perhaps a new key in book.toml under the "search" options for "hot_key"? Implementation wise, the simplest mechanism would be a token inside search.js that gets replaced inside mod.rs. Too hacky?
|
|
Yea, it would go in the search option. I'd avoid embedding javascript in the config. |
|
That's a promising idea to explore...if the |
|
I'm going to close since there hasn't been much activity for a while. If you want to pick this back up, feel free to open a new PR! |
Ruin0x11
pushed a commit
to Ruin0x11/mdBook
that referenced
this pull request
Aug 30, 2020
Addresses rust-lang#1020 with the suggestion from prior PR rust-lang#1101
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.
As currently implemented, any time the S key is pressed outside of the search interface, that keystroke is intercepted and the search interface is displayed. This causes problems when interactive widgets are embedded on the page (as raised in #1020).
This PR instead switches to ALT+S so that interactive widgets can be displayed on the page (and more generally, makes the S key available to JavaScript running on the page). Rationale for ALT+S:
event.keyMetain javascript) to save