Add immediate prop to <Combobox /> for immediately opening the Combobox when the input receives focus
#2686
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
… selected item
When you have a fwe inputs such as:
```html
<form>
<input />
<input />
<input />
<Combobox>
<Combobox.Input />
</Combobox>
<input />
<input />
<input />
</form>
```
Tabbing through this list will open the combobox once you are on the
input field. When you continue tabbing, the first item would be
selected. However, if the combobox is not marked as nullable, it means
that just going through the form means that we set a value we can't
unset anymore.
We still want to open the combobox, we just don't want to select
anything in this case.
outside If the focus is coming from the `<Combobox.Button />` or as a side effect of selecting an `<Combobox.Option />` then we don't want to re-open the `<Combobox />`
…sing the input field
RobinMalfait
changed the title
immediate prop to <Combobox /> for immediately opening the Combobox when the input receives focus
Safari doesn't fire a `focus` event when clicking a button, therefore it does not become the `document.activeElement`, and events like `blur` or `focus` doesn't set the button as the `event.relatedTarget`. Keeping track of a history like this solves that problem. We already had the code for the `FocusTrap` component.
|
Hey, thanks so much for this contribution! 🙏 I made a few adjustments, and we decided to name the prop You can already try it using:
|
|
@RobinMalfait thank you for your adjustments and for merging this PR! Much appreciated! |
2 tasks
This was referenced May 28, 2024
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.
Maintainers note:
This PR introduces a new
immediateprop on the<Combobox />component to open the<Combobox />immediately once the<Combobox.Input />receives focus.It does handle edge cases where focus is moved into the
<Combobox.Input />without opening the<Combobox />again. These edge cases are:<Combobox.Button />to close the<Combobox />will move focus into the<Combobox.Input />this will not open the<Combobox />again.<Combobox.Option />will temporarely move focus to the<Combobox.Option />, then focus is moved back into the<Combobox.Input />. This will not open the<Combobox />again.Another edge case that is important to mention:
<Combobox />is open, the first<Combobox.Option />is selected. Tabbing away will select the currently active<Combobox.Option />. Ifimmediatemode is enabled, and you are tabbing through a form with multiple inputs, once you hit the<Combobox.Input />the<Combobox />will be opened and the first<Combobox.Option />will be selected. Tabbing again will not select this option to prevent accidental and unwanted state mutations to the current form.This is my attempt to make combobox options open on input focus, as there're many requests in discussions (#1236).
This adds boolean
openOnFocusprop both to Vue'sComboboxInput& React'sCombobox.Inputcomponents. Initially I tried to add it to rootComboboxcomponents, but due to my lack of React & TS types knowledge, I couldn't figure out how to introduce new boolean prop on React's component.If
openOnFocusis present, focusing on input (by clicking on label/input or tabbing into input) will make options list appear. I made sure that this changes properly work when options list is already visible and user tries to close it by clicking the combobox button. Also it won't show options list if combobox button is disabled.handleFocusfunction insideComboboxInputcomponents checks if options list should be opened. TheHTMLBodyElementinstance check added mostly for tests because for some reason body element is being passed asrelatedTargetin test environment and it breaks the checks.The only UI change this PR introduces is when user clicks on some option in single-mode combobox or clicks the button, input won't be refocused. I added additional check for
openOnFocusprop (to the!isMobile()condition and to button'shandleClick) before refocusing input because without it options list will stay open until user clicks on something non-related to combobox.I'm not sure what scenario is better (not refocusing input or not closing combobox), so I decided to make it at least visually similar to how combobox works now.
Also, in React component I added new action
SetOpenOnFocusbecause I needed to somehow mutateopenOnFocusvalue ofComboboxDataContextsoComboboxOptioncomponent can perform check before refocusing input. I have limited experience with React, so I don't know if this is the best way to do it.I added several new tests around openOnFocus prop and created new playground pages (
http://localhost:3000/combobox/combobox-open-on-focus) for both frameworks (they are copy-pasted from pure Tailwind examples).