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.

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

Jump to bottom

Support exit animation on Dialog without explicit store #3531

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Support exit animation on Dialog without explicit store #3531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
523f4ed
Support exit animation on Dialog without explicit store
diegohaz Feb 29, 2024
01c843c
Add changeset
diegohaz Feb 29, 2024
c21a863
Merge branch 'main' into dialog-unmount-leave-animation-without-store
diegohaz Feb 29, 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
8 changes: 8 additions & 0 deletions .changeset/3531-dialog-unmount-leave-animation-without-store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@ariakit/react-core": patch
"@ariakit/react": patch
---

Improved exit animation for the `Dialog` component

In previous versions, if you used the [`Dialog`](https://ariakit.org/reference/dialog) component along with the [`unmountOnHide`](https://ariakit.org/reference/dialog#unmountonhide) prop without passing a [`store`](https://ariakit.org/reference/dialog#store) or wrapping it with [`DialogProvider`](https://ariakit.org/reference/dialog-provider), leave animations and transitions wouldn't run. This behavior should now be more consistent across different use cases.
60 changes: 28 additions & 32 deletions examples/dialog-animated-various/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,23 @@ export default function Example() {
<Ariakit.DialogDismiss className="button">Close</Ariakit.DialogDismiss>
</Ariakit.Dialog>

<Ariakit.DialogProvider
<Ariakit.Button
onClick={() => setTransitionUnmount(true)}
className="button"
>
TransitionUnmount
</Ariakit.Button>
<Ariakit.Dialog
unmountOnHide
open={transitionUnmount}
setOpen={setTransitionUnmount}
onClose={() => setTransitionUnmount(false)}
className="dialog dialog-transition"
>
<Ariakit.Button
onClick={() => setTransitionUnmount(true)}
className="button"
>
<Ariakit.DialogHeading className="heading">
TransitionUnmount
</Ariakit.Button>
<Ariakit.Dialog unmountOnHide className="dialog dialog-transition">
<Ariakit.DialogHeading className="heading">
TransitionUnmount
</Ariakit.DialogHeading>
<Ariakit.DialogDismiss className="button">
Close
</Ariakit.DialogDismiss>
</Ariakit.Dialog>
</Ariakit.DialogProvider>
</Ariakit.DialogHeading>
<Ariakit.DialogDismiss className="button">Close</Ariakit.DialogDismiss>
</Ariakit.Dialog>

<Ariakit.Button
onClick={() => setTransitionNoModal(true)}
Expand Down Expand Up @@ -188,25 +186,23 @@ export default function Example() {
<Ariakit.DialogDismiss className="button">Close</Ariakit.DialogDismiss>
</Ariakit.Dialog>

<Ariakit.DialogProvider
<Ariakit.Button
onClick={() => setAnimationUnmountLeave(true)}
className="button"
>
AnimationUnmountLeave
</Ariakit.Button>
<Ariakit.Dialog
unmountOnHide
open={animationUnmountLeave}
setOpen={setAnimationUnmountLeave}
onClose={() => setAnimationUnmountLeave(false)}
className="dialog dialog-animation-leave"
>
<Ariakit.Button
onClick={() => setAnimationUnmountLeave(true)}
className="button"
>
<Ariakit.DialogHeading className="heading">
AnimationUnmountLeave
</Ariakit.Button>
<Ariakit.Dialog unmountOnHide className="dialog dialog-animation-leave">
<Ariakit.DialogHeading className="heading">
AnimationUnmountLeave
</Ariakit.DialogHeading>
<Ariakit.DialogDismiss className="button">
Close
</Ariakit.DialogDismiss>
</Ariakit.Dialog>
</Ariakit.DialogProvider>
</Ariakit.DialogHeading>
<Ariakit.DialogDismiss className="button">Close</Ariakit.DialogDismiss>
</Ariakit.Dialog>
</div>
);
}
21 changes: 20 additions & 1 deletion packages/ariakit-react-core/src/dialog/dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,24 @@ export function createDialogComponent<T extends DialogOptions>(
});
}

export function createDialogComponentWithStore<T extends DialogOptions>(
Component: FC<T>,
useStore = useDialogStore,
useProviderContext = useDialogProviderContext,
) {
return forwardRef(function DialogComponent(props: T) {
const context = useProviderContext();
const storeProp = props.store || context;
const store = useStore({ store: storeProp, open: props.open });
const mounted = useStoreState(
store,
(state) => !props.unmountOnHide || state?.mounted || !!props.open,
);
if (!mounted) return null;
return <Component {...props} store={store} />;
});
}

/**
* Renders a dialog similar to the native `dialog` element that's rendered in a
* [`portal`](https://ariakit.org/reference/dialog#portal) by default.
Expand All @@ -564,11 +582,12 @@ export function createDialogComponent<T extends DialogOptions>(
* </Dialog>
* ```
*/
export const Dialog = createDialogComponent(
export const Dialog = createDialogComponentWithStore(
forwardRef(function Dialog(props: DialogProps) {
const htmlProps = useDialog(props);
return createElement(TagName, htmlProps);
}),
useDialogStore,
useDialogProviderContext,
);

Expand Down
Loading