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

Fix visual jitter in Combobox component when using native scrollbar #3190

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/@headlessui-react/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Keep `<Combobox />` open when clicking scrollbar in `<ComboboxOptions>` ([#3249](https://github.com/tailwindlabs/headlessui/pull/3249))
- Merge incoming `style` prop on `ComboboxOptions`, `ListboxOptions`, `MenuItems`, and `PopoverPanel` components ([#3250](https://github.com/tailwindlabs/headlessui/pull/3250))
- Prevent focus on `<Checkbox />` when it is `disabled` ([#3251](https://github.com/tailwindlabs/headlessui/pull/3251))
- Fix visual jitter in `Combobox` component when using native scrollbar ([#3190](https://github.com/tailwindlabs/headlessui/pull/3190))

## [2.0.4] - 2024-05-25

Expand Down
25 changes: 15 additions & 10 deletions packages/@headlessui-react/src/components/combobox/combobox.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1671,21 +1671,26 @@ function OptionsFn<TTag extends ElementType = typeof DEFAULT_OPTIONS_TAG>(
}, [data])

// When the user scrolls **using the mouse** (so scroll event isn't appropriate)
// we want to make sure that the current activation trigger is set to pointer
// we want to make sure that the current activation trigger is set to pointer.
let handleWheel = useEvent(() => {
actions.setActivationTrigger(ActivationTrigger.Pointer)
})

// When clicking inside of the scrollbar, a `click` event will be triggered on
// the focusable element _below_ the scrollbar. If you use a `<Combobox>`
// inside of a `<Dialog>`, clicking the scrollbar of the `<ComboboxOptions>`
// will move focus to the `<Dialog>` which blurs the `<ComboboxInput>` and
// closes the `<Combobox>`.
//
// Preventing the default behavior in the `mousedown` event (which happens
// before `click`) will prevent this issue because the `click` never fires.
let handleMouseDown = useEvent((event: ReactMouseEvent) => {
// When clicking inside of the scrollbar, a `click` event will be triggered
// on the focusable element _below_ the scrollbar. If you use a `<Combobox>`
// inside of a `<Dialog>`, clicking the scrollbar of the `<ComboboxOptions>`
// will move focus to the `<Dialog>` which blurs the `<ComboboxInput>` and
// closes the `<Combobox>`.
//
// Preventing the default behavior in the `mousedown` event (which happens
// before `click`) will prevent this issue because the `click` never fires.
event.preventDefault()

// When the user clicks in the `<Options/>`, we want to make sure that we
// set the activation trigger to `pointer` to prevent auto scrolling to the
// active option while the user is scrolling.
actions.setActivationTrigger(ActivationTrigger.Pointer)
RobinMalfait marked this conversation as resolved.
Show resolved Hide resolved
})

let ourProps = mergeProps(anchor ? getFloatingPanelProps() : {}, {
Expand All @@ -1700,7 +1705,7 @@ function OptionsFn<TTag extends ElementType = typeof DEFAULT_OPTIONS_TAG>(
'--input-width': useElementSize(data.inputRef, true).width,
'--button-width': useElementSize(data.buttonRef, true).width,
} as CSSProperties,
onWheel: handleWheel,
onWheel: data.activationTrigger === ActivationTrigger.Pointer ? undefined : handleWheel,
onMouseDown: handleMouseDown,
})

Expand Down
Loading