Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove shortcut hint in search field on mobile #1944

Closed
timhoffm opened this issue Aug 2, 2024 · 4 comments · Fixed by #1947
Closed

Remove shortcut hint in search field on mobile #1944

timhoffm opened this issue Aug 2, 2024 · 4 comments · Fixed by #1947

Comments

@timhoffm
Copy link
Contributor

timhoffm commented Aug 2, 2024

The search field contains the "Ctrl + K" shortcut hint. This is useful on keyboard PCs. IMHO it doesn't provide value on mobile. Additionally, the search field is smaller on mobile so that it's quite crowded. Would it be an option to remove the shortcut hint on mobile?

Search field with shortcut hint on mobile:
image

@Carreau
Copy link
Collaborator

Carreau commented Aug 5, 2024

I'm going to maybe go further and say that it's not necessary at all on the modal, as it is on the button ?
Screenshot 2024-08-05 at 10 02 28

Carreau added a commit to Carreau/pydata-sphinx-theme that referenced this issue Aug 5, 2024
The shortcut is already present on the navbar button that will show the
modal, thus it is likely unnecessary on the modal itself.

As pointed out in pydata#1944, this is also super crowded on mobile,
so less element is actually cleaner.

This also remove Ctrl-K from the search field on the search page, but
again, It is likely unnecessary there, as the user is already on the
search page.

In general I think removing is better than having it as an option as it
is less maintenance.

Closes pydata#1944
Carreau added a commit to Carreau/pydata-sphinx-theme that referenced this issue Aug 5, 2024
The shortcut is already present on the navbar button that will show the
modal, thus it is likely unnecessary on the modal itself.

As pointed out in pydata#1944, this is also super crowded on mobile,
so less element is actually cleaner.

This also remove Ctrl-K from the search field on the search page, but
again, It is likely unnecessary there, as the user is already on the
search page.

In general I think removing is better than having it as an option as it
is less maintenance.

Closes pydata#1944
@trallard
Copy link
Collaborator

trallard commented Aug 5, 2024

I think it should be ok removing it as the modal is already enabled so the user should not need access to the shortcut anyway.
I will ping @smeragoel just in case there are UX considerations

@timhoffm
Copy link
Contributor Author

timhoffm commented Aug 5, 2024

I‘d prefer to keep the shortcut in the modal on large screens. See my comment in the PR.

timhoffm added a commit to timhoffm/pydata-sphinx-theme that referenced this issue Aug 6, 2024
@smeragoel
Copy link

I agree that the "Ctrl + K" shortcut text should be removed from the search field on mobile screens to improve usability and prevent clutter. But we should keep the shortcut text in the search modal for desktop users, based on @timhoffm's comment, and the examples provided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants