Add controller for search focus for slash keypress #10395
Merged
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
While having the search key autofocus is forbidden, having a keypress focus the search field is a desirable feature. Add a new Stumulus Controller that listens to the `/` keypress and focuses the input on the search field. Note: Currently applies only to the home page. Refs: pypi#6099 Signed-off-by: Mike Fiedler <miketheman@gmail.com>
|
Thanks! I think if we add a check that the cursor is not currently in an input field, we could add this to the base template, so this is usable everywhere the search box is currently present. |
|
Happy to look at that change as well - but then I'm not sure how the base template property would be inherited to the homepage's search box? |
|
It wouldn't, we'd need to add it to both the form on the homepage (which you've already done here) and to this form: https://github.com/pypa/warehouse/blob/597938cff04261fd55f59dd538982b4bfcad4621/warehouse/templates/base.html#L225-L233 |
Instead of registering a listener, use an action to inform the controller to take an action. Signed-off-by: Mike Fiedler <miketheman@gmail.com>
In order to prevent the feature from taking over other input fields, only activate when NOT in an input field, so the `/` key can be used in any input field and not interfere with inputs. Signed-off-by: Mike Fiedler <miketheman@gmail.com>
|
@di I think I'm ready for another review! I'm happier with this implementation - it's more tightly scoped, albeit increasing the html line length. |
di
approved these changes
Nov 30, 2021
|
Thanks, this is great! |
domdfcoding
pushed a commit
to domdfcoding/warehouse
that referenced
this pull request
Jun 7, 2022
* Add controller for search focus for slash keypress While having the search key autofocus is forbidden, having a keypress focus the search field is a desirable feature. Add a new Stumulus Controller that listens to the `/` keypress and focuses the input on the search field. Note: Currently applies only to the home page. Refs: pypi#6099 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * refactor: use stimulus action instead of a listener Instead of registering a listener, use an action to inform the controller to take an action. Signed-off-by: Mike Fiedler <miketheman@gmail.com> * feat: add search focus to base template In order to prevent the feature from taking over other input fields, only activate when NOT in an input field, so the `/` key can be used in any input field and not interfere with inputs. Signed-off-by: Mike Fiedler <miketheman@gmail.com>
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.
While having the search key autofocus is forbidden, having a keypress
focus the search field is a desirable feature.
Add a new Stimulus Controller that listens to the
/keypress andfocuses the input on the search field.
Note: Currently applies only to the home page.
Fixes #6099
Signed-off-by: Mike Fiedler miketheman@gmail.com