AccordionOptions

icon

Element

store

DisclosureStoreFunctions & Store<DisclosureStoreState> & { useState: UseState<DisclosureStoreState>; }

title

enum

ActiveBarOptions

activeTab

HTMLElement

listRef

MutableRefObject<undefined>

AlertOptions

closeButtonDataTestId

string

@description add a close button with an onclick handleClose function

handleClose

() => void

isFullWidth

size

variant

AspectRatioOptions

ratio

number

AvatarOptions

color

getInitials

(name: string) => string

name

ShapeOptions

shape

ListOptions

emojis

Emoji[]

emptyList

inputSearchPlaceholder

isOpen

onChange

(value: string) => void

value

DisclosureStoreOptions

The default visibility state of the content.

defaultOpen

A reference to another disclosure store that controls another disclosure
component to keep them in sync. Element states like `contentElement` and
`disclosureElement` won't be synced. For that, use the `store` prop
instead.

disclosure

DisclosureStoreFunctions & Store<DisclosureStoreState>

A callback that gets called when the `mounted` state changes.
@param mounted The new mounted value.
@example const [mounted, setMounted] = useState(false);
const disclosure = useDisclosureStore({ setMounted });

setMounted

(mounted: boolean) => void

A callback that gets called when the `open` state changes.
@param open The new open value.
@example const [open, setOpen] = useState(false);
const disclosure = useDisclosureStore({ open, setOpen });

setOpen

(open: boolean) => void

ItemOptions

isActive

separator

ButtonOptions

disabled

ButtonGroupOptions

CoverOptions

CheckboxOptions

Component

checked

TypeLiteral

hasIcon

iconPlacement

indeterminate

isClearable

(event: ChangeEvent<HTMLInputElement>) => void

transparent

ContentOptions

onClose

CustomHeaderOptions

endYear

CustomInputOptions

DatePickerOptions

onBlur

(event: FocusEvent<HTMLDivElement, Element>) => void

(date?: Date) => void

onFocus

placeholder

startYear

useWeekdaysShort

Enables basic storage and retrieval of dates and times.

TimePickerOptions

((date?: Date) => void) & ((date?: Date) => void)

FocusableOptions

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).

accessibleWhenDisabled

DisclosureContentOptions

Determines whether the content element should remain visible even when the
`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)

alwaysVisible

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.

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)

autoFocus

DialogOptions

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` prop can be used to define a different
element to be focused.

autoFocusOnHide

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` 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)

autoFocusOnShow

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.

**If a custom component is used, it must accept ref and spread all props to
its underlying DOM element**, 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" />} />
```

backdrop

Props that will be passed to the backdrop element if
[`backdrop`](https://ariakit.org/reference/dialog#backdrop) is `true`.
@deprecated Use the
[`backdrop`](https://ariakit.org/reference/dialog#backdrop) prop instead.

backdropProps

Pick<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof HTMLAttributes<HTMLDivElement>> & { ...; }

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.

Live examples:
- [Submenu](https://ariakit.org/examples/menu-nested)

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). However, if `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.

finalFocus

Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.

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/components/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.

focusable

When a dialog is open, the elements outside of it will be disabled so they
can't be interacted with if the dialog is modal. For non-modal dialogs,
interacting with elements outside of the dialog will close it. With this
function, you can return a collection of elements that will be considered
part of the dialog and therefore will be excluded from this behavior.

Live examples:
- [Dialog with
  React-Toastify](https://ariakit.org/examples/dialog-react-toastify)

getPersistentElements

() => Iterable<Element>

Determines whether the dialog will be hidden when the user presses the
Escape key.

hideOnEscape

Determines whether the dialog will be hidden when the user clicks or focus
on an element outside of the dialog.

Live examples:
- [Selection Popover](https://ariakit.org/examples/popover-selection)

hideOnInteractOutside

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.

initialFocus

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`.
- 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 disabled.
- 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`.

Live examples:
- [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)

modal

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 cancelled 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)

(event: Event) => void

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 a
programmatic equivalent of the `data-focus-visible` attribute.

Live examples:
- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)

onFocusVisible

BivariantCallback<(event: SyntheticEvent<Element, Event>) => void>

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)

open

DrawerOptions

placement

PortalOptions

Determines whether the element should be rendered as a React Portal.

portal

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`.
@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} />
```

portalElement

`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.
@example ```jsx
const [portalElement, setPortalElement] = useState(null);

<Portal portalRef={setPortalElement} />
```

portalRef

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.

preserveTabOrder

Determines whether the body scrolling will be prevented when the dialog is
shown.

preventBodyScroll

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.

DialogStoreFunctions & DisclosureStoreFunctions & Store<DisclosureStoreState> & { useState: UseState<...>; }

When set to `true`, the content element will be unmounted and removed from
the DOM when it's hidden.

Live examples:
- [Combobox with links](https://ariakit.org/examples/combobox-links)
- [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)

unmountOnHide

withBackdrop

withCloseButton

DrawerBackdropOptions

PopoverOptions

The minimum padding between the arrow and the popover corner.

arrowPadding

CompositeOptions

Whether the component should behave as a composite widget. This prop should
be set to `false` when combining different composite widgets where only one
should behave as such.

composite

HovercardOptions

Whether to disable the pointer events outside of the hovercard while the
mouse is moving toward the hovercard. This is necessary because these
events may trigger focus on other elements and close the hovercard while
the user is moving the mouse toward it.

disablePointerEventsOnApproach

Whether the popover should fit the viewport. If this is set to true, the
popover wrapper will have `maxWidth` and `maxHeight` set to the viewport
size. This will be exposed to CSS as
[`--popover-available-width`](https://ariakit.org/guide/styling#--popover-available-width)
and
[`--popover-available-height`](https://ariakit.org/guide/styling#--popover-available-height).

fitViewport

Whether the popover has `position: fixed` or not.

fixed

Controls the behavior of the popover when it overflows the viewport:
- If a `boolean`, specifies whether the popover should flip to the opposite
  side when it overflows.
- If a `string`, indicates the preferred fallback placements when it
  overflows. The placements must be spaced-delimited, e.g. "top left".

flip

Whether the active composite item should receive focus when `store.move` is
called.

focusOnMove

Function that returns the anchor element's DOMRect. If this is explicitly
passed, it will override the anchor `getBoundingClientRect` method.

Live examples:
 - [Textarea with inline combobox](https://ariakit.org/examples/combobox-textarea)
 - [Standalone Popover](https://ariakit.org/examples/popover-standalone)
 - [Context menu](https://ariakit.org/examples/menu-context-menu)
 - [Selection Popover](https://ariakit.org/examples/popover-selection)
@param anchor The anchor element.

getAnchorRect

(anchor: HTMLElement) => AnchorRect

DropdownMenuOptions

gutter

Whether to hide the popover when the mouse cursor leaves any hovercard
element, including the hovercard popover itself, but also the anchor
element.

hideOnHoverOutside

add custom props from styled system on DropdownMenu inner

innerProps

WuiProps

Whether the composite widget should move focus to an item when pressing
arrow keys.

moveOnKeyPress

The minimum padding between the popover and the viewport edge. This will be
exposed to CSS as
[`--popover-overflow-padding`](https://ariakit.org/guide/styling#--popover-overflow-padding).

overflowPadding

Whether the popover can overlap the anchor element when it overflows.

overlap

Whether the popover should have the same width as the anchor element. This
will be exposed to CSS as
[`--popover-anchor-width`](https://ariakit.org/guide/styling#--popover-anchor-width).

sameWidth

The skidding of the popover along the anchor element. Can be set to
negative values to make the popover shift to the opposite side.

shift

Whether the popover should slide when it overflows.

slide

MenuListOptions

Object returned by the
[`useMenuStore`](https://ariakit.org/reference/use-menu-store) hook. If not
provided, the closest
[`MenuProvider`](https://ariakit.org/reference/menu-provider) component's
context will be used.

MenuStoreFunctions<...> & MenuStoreFunctions<...> & Store<MenuStoreState<MenuStoreValues>> & { ...; }

CompositeTypeaheadOptions

Determines whether the typeahead behavior is enabled.

typeahead

A callback that will be called when the popover needs to calculate its
position. This will override the internal `updatePosition` function. The
original `updatePosition` function will be passed as an argument, so it can
be called inside the callback to apply the default behavior.

Live examples:
 - [Responsive Popover](https://ariakit.org/examples/popover-responsive)

updatePosition

(props: { updatePosition: () => Promise<void>; }) => void | Promise<void>

Props that will be passed to the popover wrapper element. This element will
be used to position the popover.

Name	Type(s)	Default
checkableField	Boolean
disabled	Boolean
disabledIcon	Element
icon	Element
variant	"error" "focused" "info" "success" "warning"
required	Boolean
withDisabledIcon	Boolean	true
htmlFor	string

Label

Usage #

Required #

Variants #

More content #

Disabled #

Properties #

Packages #

Dependencies #

Peer dependencies #