Automatically scroll on details menu when it opens off-screen #59
Conversation
This file contains hidden or 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
sampart
reviewed
Jun 28, 2022
If the details menu button is at the bottom of the page. we don't automatically scroll the page to show you the dropdown options. While there is an `autofocus` attribute we can use, there are two problems with it: 1. it only works with inputs 2. it doesn't scroll smoothly so the experience not as smooth when you open the menu. Let's use scrollIntoView and center on the details menu.
c97f615 to
b6f8d92
Compare
theinterned
reviewed
Jun 29, 2022
There was a problem hiding this comment.
I worry that this interaction might be unexpected. Have you considered instead detecting when the menu is close to the bottom of the window, and opening upward instead?
This is what the native select does for example:
Screenshot from https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select
|
Follow up, we have a behaviour that can be used for this https://github.com/primer/behaviors/blob/main/docs/anchored-position.md |
|
@theinterned Thanks for linking to that. Will have a proper read! |
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.
What are you trying to accomplish?
If the details menu button is at the bottom of the page, we don't automatically scroll the page to show you the dropdown options.
Example: dismissing code scanning alerts
When you click the "Dismiss alert" button in the code scanning alerts section, it will show you a list of three options in a dropdown.
However, when the "Dismiss alert" button is at the bottom of the page, we don't automatically scroll the page to show you the dropdown options. This leads to a bad experience as users might not notice there's a dropdown or they get a cut-off view of it:
What approach did you choose and why?
To fix this, let's listen for the
openevent on the dropdown menu and scroll the menu into view when it triggers.I initially tried doing this by adding the
autofocusproperty to the dropdown as the details component comes with this out-of-the-box. Unfortunately, that didn't work because that property can only be used withinput, while we're using a radio group.I then experimented with adding the
autofocusto the first or last element in the radio button list (since it's actually an input) but the scrolling was not very smooth and it didn't really centre the dropdown menu in a pleasant way.With
scrollIntoView, the dropdown is always centred:Screen.Recording.2022-06-28.at.11.53.19.mov
Testing
I've added a unit test to illustrate how this should be used.
Documentation
I've also added an example to the examples file.
Feedback
Any feedback welcome!
Anything else
This also addresses: #58