|
|
--- |
|
|
title: Dialog |
|
|
description: Used to display a dialog prompt |
|
|
links: |
|
|
source: components/dialog |
|
|
storybook: components-dialog--basic |
|
|
recipe: dialog |
|
|
ark: https://ark-ui.com/react/docs/components/dialog |
|
|
--- |
|
|
|
|
|
<ExampleTabs name="dialog-basic" /> |
|
|
|
|
|
|
|
|
|
|
|
```tsx |
|
|
import { Dialog } from "@chakra-ui/react" |
|
|
``` |
|
|
|
|
|
```tsx |
|
|
<Dialog.Root> |
|
|
<Dialog.Trigger /> |
|
|
<Dialog.Backdrop /> |
|
|
<Dialog.Positioner> |
|
|
<Dialog.Content> |
|
|
<Dialog.CloseTrigger /> |
|
|
<Dialog.Header> |
|
|
<Dialog.Title /> |
|
|
</Dialog.Header> |
|
|
<Dialog.Body /> |
|
|
<Dialog.Footer /> |
|
|
</Dialog.Content> |
|
|
</Dialog.Positioner> |
|
|
</Dialog.Root> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Use the `size` prop to change the size of the dialog component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-sizes" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `size="cover"` prop to make the dialog component cover the entire screen |
|
|
while revealing a small portion of the page behind. |
|
|
|
|
|
<ExampleTabs name="dialog-with-cover" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `size="full"` prop to make the dialog component take up the entire |
|
|
screen. |
|
|
|
|
|
<ExampleTabs name="dialog-with-fullscreen" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `placement` prop to change the placement of the dialog component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-placement" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `open` and `onOpenChange` prop to control the visibility of the dialog |
|
|
component. |
|
|
|
|
|
<ExampleTabs name="dialog-controlled" /> |
|
|
|
|
|
|
|
|
|
|
|
An alternative way to control the dialog is to use the `RootProvider` component |
|
|
and the `useDialog` store hook. |
|
|
|
|
|
This way you can access the dialog state and methods from outside the dialog. |
|
|
|
|
|
<ExampleTabs name="dialog-with-store" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `DialogContext` component to access the dialog state and methods from |
|
|
outside the dialog. |
|
|
|
|
|
<ExampleTabs name="dialog-with-context" /> |
|
|
|
|
|
|
|
|
|
|
|
You can nest dialogs by using the `Dialog.Root` component inside another |
|
|
`Dialog.Root` component. |
|
|
|
|
|
<ExampleTabs name="dialog-nested" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `initialFocusEl` prop to set the initial focus of the dialog component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-initial-focus" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `scrollBehavior=inside` prop to change the scroll behavior of the dialog |
|
|
when its content overflows. |
|
|
|
|
|
<ExampleTabs name="dialog-with-inside-scroll" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `scrollBehavior=outside` prop to change the scroll behavior of the |
|
|
dialog when its content overflows. |
|
|
|
|
|
<ExampleTabs name="dialog-with-outside-scroll" /> |
|
|
|
|
|
|
|
|
|
|
|
Use the `motionPreset` prop to change the animation of the dialog component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-motion-preset" /> |
|
|
|
|
|
|
|
|
|
|
|
Set the `role: "alertdialog"` prop to change the dialog component to an alert |
|
|
dialog. |
|
|
|
|
|
<ExampleTabs name="dialog-with-role" /> |
|
|
|
|
|
|
|
|
|
|
|
Here's an example of how to customize the `Dialog.CloseTrigger` component to |
|
|
position the close button outside the dialog component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-close-outside" /> |
|
|
|
|
|
|
|
|
|
|
|
We don't recommend using a non-modal dialog due to the accessibility concerns |
|
|
they present. In event you need it, here's what you can do: |
|
|
|
|
|
- set the `modal` prop to `false` |
|
|
- set `pointerEvents` to `none` on the `Dialog.Positioner` component |
|
|
- (optional)set the `closeOnInteractOutside` prop to `false` |
|
|
|
|
|
<ExampleTabs name="dialog-non-modal" /> |
|
|
|
|
|
|
|
|
|
|
|
Here's an example of how to compose the dialog component with the `DataList` |
|
|
component. |
|
|
|
|
|
<ExampleTabs name="dialog-with-datalist" /> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<PropTable component="Dialog" part="Root" /> |
|
|
|