Skip to content

Ensure unmount on Dialog works in combination with the transition prop on DialogBackdrop and DialogPanel components #3352

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.

Sign up for GitHub

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 2 commits into from
Jul 1, 2024
Merged

Ensure unmount on Dialog works in combination with the transition prop on DialogBackdrop and DialogPanel components #3352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d7e3e4
inherit `unmount` from `Dialog` in `DialogBackdrop` and `DialogPanel`…
RobinMalfait Jul 1, 2024
9149268
update changelog
RobinMalfait Jul 1, 2024
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- Fix prematurely added anchoring styles on `ListboxOptions` ([#3337](https://github.com/tailwindlabs/headlessui/pull/3337))
- Ensure `unmount` on `Dialog` works in combination with the `transition` prop on `DialogBackdrop` and `DialogPanel` components ([#3352](https://github.com/tailwindlabs/headlessui/pull/3352))

## [2.1.1] - 2024-06-26

Expand Down
17 changes: 11 additions & 6 deletions packages/@headlessui-react/src/components/dialog/dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ let DialogContext = createContext<
| [
{
dialogState: DialogStates
unmount: boolean
close(): void
setTitleId(id: string | null): void
},
Expand Down Expand Up @@ -121,6 +122,7 @@ let InternalDialog = forwardRefWithAs(function InternalDialog<
role = 'dialog',
autoFocus = true,
__demoMode = false,
unmount = false,
...theirProps
} = props

Expand Down Expand Up @@ -248,8 +250,8 @@ let InternalDialog = forwardRefWithAs(function InternalDialog<
let [describedby, DescriptionProvider] = useDescriptions()

let contextBag = useMemo<ContextType<typeof DialogContext>>(
() => [{ dialogState, close, setTitleId }, state],
[dialogState, state, close, setTitleId]
() => [{ dialogState, close, setTitleId, unmount }, state],
[dialogState, state, close, setTitleId, unmount]
)

let slot = useMemo(
Expand All @@ -265,6 +267,7 @@ let InternalDialog = forwardRefWithAs(function InternalDialog<
'aria-modal': __demoMode ? undefined : dialogState === DialogStates.Open ? true : undefined,
'aria-labelledby': state.titleId,
'aria-describedby': describedby,
unmount,
}

let shouldMoveFocusInside = !useIsTouchDevice()
Expand Down Expand Up @@ -421,7 +424,7 @@ function PanelFn<TTag extends ElementType = typeof DEFAULT_PANEL_TAG>(
) {
let internalId = useId()
let { id = `headlessui-dialog-panel-${internalId}`, transition = false, ...theirProps } = props
let [{ dialogState }, state] = useDialogContext('Dialog.Panel')
let [{ dialogState, unmount }, state] = useDialogContext('Dialog.Panel')
let panelRef = useSyncRefs(ref, state.panelRef)

let slot = useMemo(
Expand All @@ -442,9 +445,10 @@ function PanelFn<TTag extends ElementType = typeof DEFAULT_PANEL_TAG>(
}

let Wrapper = transition ? TransitionChild : Fragment
let wrapperProps = transition ? { unmount } : {}

return (
<Wrapper>
<Wrapper {...wrapperProps}>
{render({
ourProps,
theirProps,
Expand Down Expand Up @@ -475,7 +479,7 @@ function BackdropFn<TTag extends ElementType = typeof DEFAULT_BACKDROP_TAG>(
ref: Ref<HTMLElement>
) {
let { transition = false, ...theirProps } = props
let [{ dialogState }] = useDialogContext('Dialog.Backdrop')
let [{ dialogState, unmount }] = useDialogContext('Dialog.Backdrop')

let slot = useMemo(
() => ({ open: dialogState === DialogStates.Open }) satisfies BackdropRenderPropArg,
Expand All @@ -485,9 +489,10 @@ function BackdropFn<TTag extends ElementType = typeof DEFAULT_BACKDROP_TAG>(
let ourProps = { ref, 'aria-hidden': true }

let Wrapper = transition ? TransitionChild : Fragment
let wrapperProps = transition ? { unmount } : {}

return (
<Wrapper>
<Wrapper {...wrapperProps}>
{render({
ourProps,
theirProps,
Expand Down