Focus search box when pressing slash#131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

hugovk wants to merge2 commits intopython:mainfromhugovk:search-focus

Closed

Focus search box when pressing slash#131

hugovk wants to merge2 commits intopython:mainfromhugovk:search-focus

Conversation

Copy link

Member

hugovk commentedJun 15, 2023•
edited
Loading

Fixes#130.

Many websites focus the search box when the forward slash/ key is pressed.

For example:

Furo themehttps://pradyunsg.me/furo/quickstart/
PyPIhttps://pypi.org/project/python-docs-theme/
GitHubFocus search box when pressing slash #130
YouTubehttps://www.youtube.com/watch?v=nMekFX2CDVk
Discordhttps://discuss.python.org/

Let's do the same.

Demo

https://python-docs-theme-previews--131.org.readthedocs.build/en/131/

Focus search box when pressing slash

0a28294

ezio-melotti reviewed

Jun 15, 2023

View reviewed changes

python_docs_theme/static/search-focus.jsShow resolvedHide resolved

Allow / to be entered into search box, don't focus if edit already fo…

e6c79f4

…cused

miketheman mentioned this pull request

Jul 25, 2023

Enable search shortcuts#135

Closed

miketheman added a commit to miketheman/python-docs-theme that referenced this pull request

Jul 27, 2023

fix: override correct tag

788fee7

When the template was made responsive, the choice was made to overridethe `body_tag` fragment.The `body_tag` block is a literal `<body>` which allows the theme developerto set properties on the `body` tag.See:sphinx-doc/sphinx#4140Instead, use the `document` block as documented.https://www.sphinx-doc.org/en/master/development/templating.html#blocksOverriding the correct block places the `mobile-nav` section _after_ themajority of the other HTML parts, which enables the correct function ofthe `/` keyboard shortcut.Resolvespython#130Closespython#131Closespython#135Signed-off-by: Mike Fiedler <miketheman@gmail.com>

miketheman mentioned this pull request

Jul 27, 2023

Use correct block, enable built-in slash keypress#141

Merged