Skip to content

Improvements to search UX #12568

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

Merged
merged 3 commits into from
Jun 8, 2021
Merged

Improvements to search UX #12568

merged 3 commits into from
Jun 8, 2021

Conversation

dylemma
Copy link
Contributor

@dylemma dylemma commented May 23, 2021

Aims to address some of the topics from #12526

  • Pressing "S" while not focused on an input/textarea will now open the search.
  • Pressing "F" while not focused on an input/textarea will focus the member filter input.
  • Pressing Escape while focused on the search/filter will clear the input and close/unfocus it
  • Search result links are now treated as block elements so you can click anywhere inside the rectangle rather than specifically on the result text.

Pressing "S" while not focused on an input/textarea will now open the search.
Pressing "F" while not focused on an input/textarea will focus the member filter input.
Pressing Escape while focused on the search/filter will clear the input and close/unfocus it
Search result links are now treated as block elements so you can click anywhere inside the rectangle rather than specifically on the result text.
Copy link
Contributor

@pikinier20 pikinier20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! The only detail that we might think about is a key which opens searchbar. I've asked some people and e.g. GitHub open searchbar on '/' button. We might discuss it.

@dylemma
Copy link
Contributor Author

dylemma commented May 25, 2021

Thanks @pikinier20!

Interesting about the searchbar key. I chose S for the same reason (GitHub opens the search bar with it). Now that you mention it, it seems both s and / work, so I think I'll update the PR to support both keys.

I'm open to suggestions/alternatives for the filter, e.g. maybe f and some other key could work?

The other thing I wasn't very sure of was how to signal to users that these key shortcuts exist. For the filter, I could probably copy what GitHub did, and put a little key icon in the side of the input. But for the search, since it's just an icon right now, I don't see an easy modification. Maybe just put the key icon inside the search input once it's open, so users can learn about it after the fact?

@dylemma dylemma requested a review from pikinier20 June 1, 2021 22:35
Copy link
Contributor

@pikinier20 pikinier20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

# Conflicts:
#	scaladoc/resources/dotty_res/styles/scalastyle.css
@dylemma
Copy link
Contributor Author

dylemma commented Jun 8, 2021

Paging @romanowski since you already merged #12595 (the description of that PR said it was intended to be merged after this one)

@pikinier20 pikinier20 merged commit d7d4a9f into scala:master Jun 8, 2021
@romanowski
Copy link
Contributor

@pikinier20 merged the PR. @dylemma thank you for your contribution and we are always open to talk about UX and related things in scaladoc :)

@dylemma dylemma deleted the search-ux branch June 8, 2021 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants