Add a quick trigger action to the Menu, Listbox and Combobox components
#3700
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ import React, { | |
| type FocusEvent as ReactFocusEvent, | ||
| type KeyboardEvent as ReactKeyboardEvent, | ||
| type MouseEvent as ReactMouseEvent, | ||
| type PointerEvent as ReactPointerEvent, | ||
| type Ref, | ||
| } from 'react' | ||
| import { flushSync } from 'react-dom' | ||
|
|
@@ -34,6 +35,7 @@ import { useLatestValue } from '../../hooks/use-latest-value' | |
| import { useOnDisappear } from '../../hooks/use-on-disappear' | ||
| import { useOutsideClick } from '../../hooks/use-outside-click' | ||
| import { useOwnerDocument } from '../../hooks/use-owner' | ||
| import { Action as QuickReleaseAction, useQuickRelease } from '../../hooks/use-quick-release' | ||
| import { useRefocusableInput } from '../../hooks/use-refocusable-input' | ||
| import { useResolveButtonType } from '../../hooks/use-resolve-button-type' | ||
| import { useScrollLock } from '../../hooks/use-scroll-lock' | ||
|
|
@@ -989,9 +991,43 @@ function ButtonFn<TTag extends ElementType = typeof DEFAULT_BUTTON_TAG>( | |
| ...theirProps | ||
| } = props | ||
|
|
||
| let [comboboxState, inputElement, optionsElement] = useSlice(machine, (state) => [ | ||
| state.comboboxState, | ||
| state.inputElement, | ||
| state.optionsElement, | ||
| ]) | ||
| let refocusInput = useRefocusableInput(inputElement) | ||
|
|
||
| let enableQuickRelease = comboboxState === ComboboxState.Open | ||
| useQuickRelease(enableQuickRelease, { | ||
| trigger: localButtonElement, | ||
| action: useCallback( | ||
| (e) => { | ||
| if (localButtonElement?.contains(e.target)) { | ||
| return QuickReleaseAction.Ignore | ||
| } | ||
|
|
||
| if (inputElement?.contains(e.target)) { | ||
| return QuickReleaseAction.Ignore | ||
| } | ||
|
|
||
| let option = e.target.closest('[role="option"]:not([data-disabled])') | ||
| if (option !== null) { | ||
| return QuickReleaseAction.Select(option as HTMLElement) | ||
| } | ||
|
|
||
| if (optionsElement?.contains(e.target)) { | ||
| return QuickReleaseAction.Ignore | ||
| } | ||
|
|
||
| return QuickReleaseAction.Close | ||
| }, | ||
| [localButtonElement, inputElement, optionsElement] | ||
| ), | ||
| close: machine.actions.closeCombobox, | ||
| select: machine.actions.selectActiveOption, | ||
| }) | ||
|
Comment on lines
+1001
to
+1029
There was a problem hiding this comment. Open to suggestions for the API here. But essentially what we want to know is:
The reason I didn't just call If we check for the time differences for any action, then it could result in the menu not closing if you were quick enough. |
||
|
|
||
| let handleKeyDown = useEvent((event: ReactKeyboardEvent<HTMLElement>) => { | ||
| switch (event.key) { | ||
| // Ref: https://www.w3.org/WAI/ARIA/apg/patterns/menu/#keyboard-interaction-12 | ||
|
|
@@ -1044,9 +1080,9 @@ function ButtonFn<TTag extends ElementType = typeof DEFAULT_BUTTON_TAG>( | |
| } | ||
| }) | ||
|
|
||
| let handlePointerDown = useEvent((event: ReactPointerEvent<HTMLButtonElement>) => { | ||
| // We use the `poitnerdown` event here since it fires before the focus | ||
| // event, allowing us to cancel the event before focus is moved from the | ||
| // `ComboboxInput` to the `ComboboxButton`. This keeps the input focused, | ||
| // preserving the cursor position and any text selection. | ||
| event.preventDefault() | ||
|
|
@@ -1074,11 +1110,6 @@ function ButtonFn<TTag extends ElementType = typeof DEFAULT_BUTTON_TAG>( | |
| let { isHovered: hover, hoverProps } = useHover({ isDisabled: disabled }) | ||
| let { pressed: active, pressProps } = useActivePress({ disabled }) | ||
|
|
||
| let slot = useMemo(() => { | ||
| return { | ||
| open: comboboxState === ComboboxState.Open, | ||
|
|
@@ -1102,7 +1133,7 @@ function ButtonFn<TTag extends ElementType = typeof DEFAULT_BUTTON_TAG>( | |
| 'aria-labelledby': labelledBy, | ||
| disabled: disabled || undefined, | ||
| autoFocus, | ||
| onPointerDown: handlePointerDown, | ||
| onKeyDown: handleKeyDown, | ||
| }, | ||
| focusProps, | ||
|
|
||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had to add this to make the tests pass