Drawer

Object returned by the [`useDialogStore`](https://ariakit.org/reference/use-dialog-store) hook. If not provided, the closest [`DialogProvider`](https://ariakit.org/reference/dialog-provider) component's context will be used. Otherwise, an internal store will be created.

Controls the open state of the dialog. This is similar to the [`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open) attribute on native dialog elements. Live examples: - [Dialog with scrollable backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable) - [Dialog with details & summary](https://ariakit.org/examples/dialog-details) - [Warning on Dialog hide](https://ariakit.org/examples/dialog-hide-warning) - [Dialog with Menu](https://ariakit.org/examples/dialog-menu)

This is an event handler prop triggered when the dialog's `close` event is dispatched. The `close` event is similar to the native dialog [`close`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/close_event) event. The only difference is that this event can be canceled with `event.preventDefault()`, which will prevent the dialog from hiding. It's important to note that this event only fires when the dialog store's [`open`](https://ariakit.org/reference/use-dialog-store#open) state is set to `false`. If the controlled [`open`](https://ariakit.org/reference/dialog#open) prop value changes, or if the dialog's visibility is altered in any other way (such as unmounting the dialog without adjusting the open state), this event won't be triggered. Live examples: - [Dialog with scrollable backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable) - [Dialog with details & summary](https://ariakit.org/examples/dialog-details) - [Warning on Dialog hide](https://ariakit.org/examples/dialog-hide-warning) - [Dialog with Menu](https://ariakit.org/examples/dialog-menu)

Determines whether the dialog is modal. Modal dialogs have distinct states and behaviors: - The [`portal`](https://ariakit.org/reference/dialog#portal) and [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll) props are set to `true`. They can still be manually set to `false`. - When using the [`Heading`](https://ariakit.org/reference/heading) or [`DialogHeading`](https://ariakit.org/reference/dialog-heading) components within the dialog, their level will be reset so they start with `h1`. - A visually hidden dismiss button will be rendered if the [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component hasn't been used. This allows screen reader users to close the dialog. - When the dialog is open, element tree outside it will be inert. Live examples: - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs) - [Dialog with details & summary](https://ariakit.org/examples/dialog-details) - [Form with Select](https://ariakit.org/examples/form-select) - [Context menu](https://ariakit.org/examples/menu-context-menu) - [Responsive Popover](https://ariakit.org/examples/popover-responsive)

Determines whether there will be a backdrop behind the dialog. On modal dialogs, this is `true` by default. Besides a `boolean`, this prop can also be a React component or JSX element that will be rendered as the backdrop. **Note**: If a custom component is used, it must [accept ref and spread all props to its underlying DOM element](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension), the same way a native element would. Live examples: - [Animated Dialog](https://ariakit.org/examples/dialog-animated) - [Dialog with scrollable backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable) - [Dialog with Framer Motion](https://ariakit.org/examples/dialog-framer-motion) - [Dialog with Menu](https://ariakit.org/examples/dialog-menu) - [Nested Dialog](https://ariakit.org/examples/dialog-nested) - [Dialog with Next.js App Router](https://ariakit.org/examples/dialog-next-router) @example ```jsx <Dialog backdrop={<div className="backdrop" />} /> ```

Determines if the dialog will hide when the user presses the Escape key. This prop can be either a boolean or a function that accepts an event as an argument and returns a boolean. The event object represents the keydown event that initiated the hide action, which could be either a native keyboard event or a React synthetic event. **Note**: When placing Ariakit dialogs inside third-party dialogs, using `event.stopPropagation()` within this function will stop the event from reaching the third-party dialog, closing only the Ariakit dialog.

Determines if the dialog should hide when the user clicks or focuses on an element outside the dialog. This prop can be either a boolean or a function that takes an event as an argument and returns a boolean. The event object represents the event that triggered the action, which could be a native event or a React synthetic event of various types. Live examples: - [Selection Popover](https://ariakit.org/examples/popover-selection)

When a dialog is open, the elements outside of it are disabled to prevent interaction if the dialog is [`modal`](https://ariakit.org/reference/dialog#modal). For non-modal dialogs, interacting with elements outside the dialog prompts it to close. This function allows you to return an iterable collection of elements that will be considered as part of the dialog, thus excluding them from this behavior. **Note**: The elements returned by this function must exist in the DOM when the dialog opens. Live examples: - [Dialog with React-Toastify](https://ariakit.org/examples/dialog-react-toastify)

Determines whether the body scrolling will be prevented when the dialog is shown. This is automatically set to `true` when the dialog is [`modal`](https://ariakit.org/reference/dialog#modal). You can disable this prop if you want to implement your own logic.

Determines whether an element inside the dialog will receive focus when the dialog is shown. By default, this is usually the first tabbable element in the dialog or the dialog itself. The [`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop can be used to set a different element to receive focus. Live examples: - [Warning on Dialog hide](https://ariakit.org/examples/dialog-hide-warning) - [Sliding Menu](https://ariakit.org/examples/menu-slide) - [Selection Popover](https://ariakit.org/examples/popover-selection)

Determines whether an element outside of the dialog will be focused when the dialog is hidden if another element hasn't been focused in the action of hiding the dialog (for example, by clicking or tabbing into another tabbable element outside of the dialog). By default, this is usually the disclosure element. The [`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be used to define a different element to be focused. Live examples: - [Dialog with Next.js App Router](https://ariakit.org/examples/dialog-next-router) - [Sliding menu](https://ariakit.org/examples/menu-slide)

Specifies the element that will receive focus when the dialog is first opened. It can be an `HTMLElement` or a `React.RefObject` with an `HTMLElement`. If [`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow) is set to `false`, this prop will have no effect. If left unset, the dialog will attempt to determine the initial focus element in the following order: 1. A [Focusable](https://ariakit.org/components/focusable) element with an [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop. 2. The first tabbable element inside the dialog. 3. The first focusable element inside the dialog. 4. The dialog element itself.

Determines the element that will receive focus once the dialog is closed, provided that no other element has been focused while the dialog was being hidden (e.g., by clicking or tabbing into another tabbable element outside of the dialog). - If [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide) is set to `false`, this prop will have no effect. - If left unset, the element that was focused before the dialog was opened will be focused again.

Determines if the element is disabled. This sets the `aria-disabled` attribute accordingly, enabling support for all elements, including those that don't support the native `disabled` attribute. This feature can be combined with the [`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled) prop to make disabled elements still accessible via keyboard. **Note**: For this prop to work, the [`focusable`](https://ariakit.org/reference/command#focusable) prop must be set to `true`, if it's not set by default. Live examples: - [Submenu](https://ariakit.org/examples/menu-nested) - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs) - [Context Menu](https://ariakit.org/examples/menu-context-menu)

Automatically focuses the element upon mounting, similar to the native `autoFocus` prop. This addresses an issue where the element with the native `autoFocus` attribute might receive focus before React effects are executed. The `autoFocus` prop can also be used with [Focusable](https://ariakit.org/components/focusable) elements within a [Dialog](https://ariakit.org/components/dialog) component, establishing the initial focus as the dialog opens. **Note**: For this prop to work, the [`focusable`](https://ariakit.org/reference/command#focusable) prop must be set to `true`, if it's not set by default. Live examples: - [Warning on Dialog hide](https://ariakit.org/examples/dialog-hide-warning) - [Dialog with React Router](https://ariakit.org/examples/dialog-react-router) - [Nested Dialog](https://ariakit.org/examples/dialog-nested)

Determines if [Focusable](https://ariakit.org/components/focusable) features should be active on non-native focusable elements. **Note**: This prop only turns off the additional features provided by the [`Focusable`](https://ariakit.org/reference/focusable) component. Non-native focusable elements will lose their focusability entirely. However, native focusable elements will retain their inherent focusability, but without added features such as improved [`autoFocus`](https://ariakit.org/reference/focusable#autofocus), [`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled), [`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible), etc.

Indicates whether the element should be focusable even when it is [`disabled`](https://ariakit.org/reference/focusable#disabled). This is important when discoverability is a concern. For example: > A toolbar in an editor contains a set of special smart paste functions that are disabled when the clipboard is empty or when the function is not applicable to the current content of the clipboard. It could be helpful to keep the disabled buttons focusable if the ability to discover their functionality is primarily via their presence on the toolbar. Learn more on [Focusability of disabled controls](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols). Live examples: - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)

Custom event handler invoked when the element gains focus through keyboard interaction or a key press occurs while the element is in focus. This is the programmatic equivalent of the [`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible) attribute. **Note**: For this prop to work, the [`focusable`](https://ariakit.org/reference/command#focusable) prop must be set to `true`, if it's not set by default. Live examples: - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation) - [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged. Check out the [Composition](https://ariakit.org/guide/composition) guide for more details.

When enabled, `preserveTabOrder` will keep the DOM element's tab order the same as the order in which the underlying [`Portal`](https://ariakit.org/reference/portal) component was mounted in the React tree. If the [`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor) prop is provided, the tab order will be preserved relative to that element.

An anchor element for maintaining the tab order when [`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder) prop is enabled. The tab order will be kept relative to this element. By default, the tab order is kept relative to the original location in the React tree where the underlying [`Portal`](https://ariakit.org/reference/portal) component was mounted. @example ```jsx {18-20} const [anchor, setAnchor] = useState(null); <button ref={setAnchor}>Order 0</button> <button>Order 2</button> // Rendered at the end of the document. <Portal> <button>Order 5</button> </Portal> // Rendered at the end of the document, but the tab order is preserved. <Portal preserveTabOrder> <button>Order 3</button> </Portal> // Rendered at the end of the document, but the tab order is preserved // relative to the anchor element. <Portal preserveTabOrder preserveTabOrderAnchor={anchor}> <button>Order 1</button> </Portal> <button>Order 4</button> ```

`portalRef` is similar to `ref` but is scoped to the portal node. It's useful when you need to be informed when the portal element is appended to the DOM or removed from the DOM. Live examples: - [Form with Select](https://ariakit.org/examples/form-select) @example ```jsx const [portalElement, setPortalElement] = useState(null); <Portal portalRef={setPortalElement} /> ```

Determines whether the element should be rendered as a React Portal. Live examples: - [Combobox with integrated filter](https://ariakit.org/examples/combobox-filtering-integrated) - [Dialog with Menu](https://ariakit.org/examples/dialog-menu) - [Hovercard with keyboard support](https://ariakit.org/examples/hovercard-disclosure) - [Menubar](https://ariakit.org/components/menubar) - [Standalone Popover](https://ariakit.org/examples/popover-standalone) - [Animated Select](https://ariakit.org/examples/select-animated)

An HTML element or a memoized callback function that returns an HTML element to be used as the portal element. By default, the portal element will be a `div` element appended to the `document.body`. Live examples: - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation) @example ```jsx const [portal, setPortal] = useState(null); <Portal portalElement={portal} /> <div ref={setPortal} /> ``` @example ```jsx const getPortalElement = useCallback(() => { const div = document.createElement("div"); const portalRoot = document.getElementById("portal-root"); portalRoot.appendChild(div); return div; }, []); <Portal portalElement={getPortalElement} /> ```

Determines whether the content element should remain visible even when the [`open`](https://ariakit.org/reference/disclosure-provider#open) state is `false`. If this prop is set to `true`, the `hidden` prop and the `display: none` style will not be applied, unless explicitly set otherwise. This prop is particularly useful when using third-party animation libraries such as Framer Motion or React Spring, where the element needs to be visible for exit animations to work. Live examples: - [Dialog with Framer Motion](https://ariakit.org/examples/dialog-framer-motion) - [Menu with Framer Motion](https://ariakit.org/examples/menu-framer-motion) - [Tooltip with Framer Motion](https://ariakit.org/examples/tooltip-framer-motion) - [Dialog with details & summary](https://ariakit.org/examples/dialog-details)

When set to `true`, the content element will be unmounted and removed from the DOM when it's hidden. Live examples: - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation) - [Combobox with integrated filter](https://ariakit.org/examples/combobox-filtering-integrated) - [Textarea with inline Combobox](https://ariakit.org/examples/combobox-textarea) - [Standalone Popover](https://ariakit.org/examples/popover-standalone) - [Animated Select](https://ariakit.org/examples/select-animated) - [Multi-Select](https://ariakit.org/examples/select-multiple)