@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/composite/composite-row.d.ts

@@ -20,32 +20,39 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeRow: import("../utils/types.js").Hook<CompositeRowOptions<"div">>;
 /**
- * Renders a composite row. Wrapping `CompositeItem` elements within
- * `CompositeRow` will create a two-dimensional composite widget, such as a
- * grid.
+ * Renders a row element for composite items that allows two-dimensional arrow
+ * key navigation.
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) elements
+ * wrapped within this component will automatically receive a
+ * [`rowId`](https://ariakit.org/reference/composite-item#rowid) prop.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeRow>
- *     <CompositeItem>Item 1.1</CompositeItem>
- *     <CompositeItem>Item 1.2</CompositeItem>
- *     <CompositeItem>Item 1.3</CompositeItem>
- *   </CompositeRow>
- *   <CompositeRow>
- *     <CompositeItem>Item 2.1</CompositeItem>
- *     <CompositeItem>Item 2.2</CompositeItem>
- *     <CompositeItem>Item 2.3</CompositeItem>
- *   </CompositeRow>
- * </Composite>
+ * ```jsx {3-12}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeRow>
+ *       <CompositeItem>Item 1.1</CompositeItem>
+ *       <CompositeItem>Item 1.2</CompositeItem>
+ *       <CompositeItem>Item 1.3</CompositeItem>
+ *     </CompositeRow>
+ *     <CompositeRow>
+ *       <CompositeItem>Item 2.1</CompositeItem>
+ *       <CompositeItem>Item 2.2</CompositeItem>
+ *       <CompositeItem>Item 2.3</CompositeItem>
+ *     </CompositeRow>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeRow: import("../utils/types.js").Component<CompositeRowOptions<"div">>;
 export interface CompositeRowOptions<T extends As = "div"> extends Options<T> {
     /**
-     * Object returned by the `useCompositeStore` hook. If not provided, the
-     * parent `Composite` component's context will be used.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`Composite`](https://ariakit.org/reference/composite) or
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * components' context will be used.
      */
     store?: CompositeStore;
 }

package/cjs/composite/composite-separator.d.cts

@@ -17,24 +17,37 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeSeparator: import("../utils/types.js").Hook<CompositeSeparatorOptions<"hr">>;
 /**
- * Renders a separator for composite items.
+ * Renders a divider between
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) elements.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeSeparator />
- *   <CompositeItem>Item 2</CompositeItem>
- * </Composite>
+ * ```jsx {4}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeSeparator />
+ *     <CompositeItem>Item 2</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeSeparator: import("../utils/types.js").Component<CompositeSeparatorOptions<"hr">>;
 export interface CompositeSeparatorOptions<T extends As = "hr"> extends SeparatorOptions<T> {
     /**
-     * Object returned by the `useCompositeStore` hook. If not provided, the
-     * parent `Composite` component's context will be used.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`Composite`](https://ariakit.org/reference/composite) or
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * components' context will be used.
      */
     store?: CompositeStore;
+    /**
+     * The orientation of the separator. By default, this is the opposite of the
+     * [`orientation`](https://ariakit.org/reference/composite-provider#orientation)
+     * state of the composite widget. Which means it doesn't need to be explicitly
+     * set in most cases.
+     */
+    orientation?: SeparatorOptions<T>["orientation"];
 }
 export type CompositeSeparatorProps<T extends As = "hr"> = Props<CompositeSeparatorOptions<T>>;

package/cjs/composite/composite-separator.d.ts

@@ -17,24 +17,37 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeSeparator: import("../utils/types.js").Hook<CompositeSeparatorOptions<"hr">>;
 /**
- * Renders a separator for composite items.
+ * Renders a divider between
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) elements.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeSeparator />
- *   <CompositeItem>Item 2</CompositeItem>
- * </Composite>
+ * ```jsx {4}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeSeparator />
+ *     <CompositeItem>Item 2</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeSeparator: import("../utils/types.js").Component<CompositeSeparatorOptions<"hr">>;
 export interface CompositeSeparatorOptions<T extends As = "hr"> extends SeparatorOptions<T> {
     /**
-     * Object returned by the `useCompositeStore` hook. If not provided, the
-     * parent `Composite` component's context will be used.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`Composite`](https://ariakit.org/reference/composite) or
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * components' context will be used.
      */
     store?: CompositeStore;
+    /**
+     * The orientation of the separator. By default, this is the opposite of the
+     * [`orientation`](https://ariakit.org/reference/composite-provider#orientation)
+     * state of the composite widget. Which means it doesn't need to be explicitly
+     * set in most cases.
+     */
+    orientation?: SeparatorOptions<T>["orientation"];
 }
 export type CompositeSeparatorProps<T extends As = "hr"> = Props<CompositeSeparatorOptions<T>>;

package/cjs/composite/composite-store.d.cts

@@ -4,11 +4,13 @@ import type { CollectionStoreFunctions, CollectionStoreOptions, CollectionStoreS
 import type { Store } from "../utils/store.js";
 export declare function useCompositeStoreProps<T extends Core.CompositeStore>(store: T, update: () => void, props: CompositeStoreProps): T;
 /**
- * Creates a composite store.
+ * Creates a composite store to control the state of
+ * [Composite](https://ariakit.org/components/composite) components.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx
  * const composite = useCompositeStore();
+ *
  * <Composite store={composite}>
  *   <CompositeItem>Item</CompositeItem>
  *   <CompositeItem>Item</CompositeItem>

package/cjs/composite/composite-store.d.ts

@@ -4,11 +4,13 @@ import type { CollectionStoreFunctions, CollectionStoreOptions, CollectionStoreS
 import type { Store } from "../utils/store.js";
 export declare function useCompositeStoreProps<T extends Core.CompositeStore>(store: T, update: () => void, props: CompositeStoreProps): T;
 /**
- * Creates a composite store.
+ * Creates a composite store to control the state of
+ * [Composite](https://ariakit.org/components/composite) components.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx
  * const composite = useCompositeStore();
+ *
  * <Composite store={composite}>
  *   <CompositeItem>Item</CompositeItem>
  *   <CompositeItem>Item</CompositeItem>

package/cjs/composite/composite-typeahead.d.cts

@@ -17,25 +17,37 @@ export declare const useCompositeTypeahead: import("../utils/types.js").Hook<Com
 /**
  * Renders a component that adds typeahead functionality to composite
  * components.
+ *
+ * When the
+ * [`typeahead`](https://ariakit.org/reference/composite-typeahead#typeahead)
+ * prop is enabled, which it is by default, hitting printable character keys
+ * will move focus to the next composite item that begins with the input
+ * characters.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite} render={<CompositeTypeahead />}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeItem>Item 2</CompositeItem>
- * </Composite>
+ * <CompositeProvider>
+ *   <Composite render={<CompositeTypeahead />}>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeItem>Item 2</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeTypeahead: import("../utils/types.js").Component<CompositeTypeaheadOptions<"div">>;
 export interface CompositeTypeaheadOptions<T extends As = "div"> extends Options<T> {
     /**
-     * Object returned by the `useCompositeStore` hook. If not provided, the
-     * parent `Composite` component's context will be used.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`Composite`](https://ariakit.org/reference/composite) or
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * components' context will be used.
      */
     store?: CompositeStore;
     /**
-     * Determines whether the typeahead behavior is enabled.
+     * When enabled, pressing printable character keys will move focus to the next
+     * composite item that starts with the entered characters.
      * @default true
      */
     typeahead?: boolean;

package/cjs/composite/composite-typeahead.d.ts

@@ -17,25 +17,37 @@ export declare const useCompositeTypeahead: import("../utils/types.js").Hook<Com
 /**
  * Renders a component that adds typeahead functionality to composite
  * components.
+ *
+ * When the
+ * [`typeahead`](https://ariakit.org/reference/composite-typeahead#typeahead)
+ * prop is enabled, which it is by default, hitting printable character keys
+ * will move focus to the next composite item that begins with the input
+ * characters.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite} render={<CompositeTypeahead />}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeItem>Item 2</CompositeItem>
- * </Composite>
+ * <CompositeProvider>
+ *   <Composite render={<CompositeTypeahead />}>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeItem>Item 2</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeTypeahead: import("../utils/types.js").Component<CompositeTypeaheadOptions<"div">>;
 export interface CompositeTypeaheadOptions<T extends As = "div"> extends Options<T> {
     /**
-     * Object returned by the `useCompositeStore` hook. If not provided, the
-     * parent `Composite` component's context will be used.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`Composite`](https://ariakit.org/reference/composite) or
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * components' context will be used.
      */
     store?: CompositeStore;
     /**
-     * Determines whether the typeahead behavior is enabled.
+     * When enabled, pressing printable character keys will move focus to the next
+     * composite item that starts with the entered characters.
      * @default true
      */
     typeahead?: boolean;

package/cjs/composite/composite.d.cts

@@ -32,27 +32,82 @@ export declare const useComposite: import("../utils/types.js").Hook<CompositeOpt
 export declare const Composite: import("../utils/types.js").Component<CompositeOptions<"div">>;
 export interface CompositeOptions<T extends As = "div"> extends FocusableOptions<T> {
     /**
-     * Object returned by the `useCompositeStore` hook.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * component's context will be used.
      */
     store?: CompositeStore;
     /**
-     * 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.
+     * Determines if the component should act as a composite widget. This prop
+     * needs to be set to `false` when merging various composite widgets where
+     * only one should function in that manner.
+     *
+     * If disabled, this component will stop managing focus and keyboard
+     * navigation for its items and itself. Additionally, composite ARIA
+     * attributes won't be applied. These responsibilities should be taken over by
+     * another composite component.
+     *
+     * **Note**: In most cases, this prop doesn't need to be set manually. For
+     * example, when composing [Menu with
+     * Combobox](https://ariakit.org/examples/menu-combobox) or [Select with
+     * Combobox](https://ariakit.org/examples/select-combobox), this prop will be
+     * set to `false` automatically on the
+     * [`Menu`](https://ariakit.org/reference/menu) and
+     * [`SelectPopover`](https://ariakit.org/reference/select-popover) components
+     * so the [`Combobox`](https://ariakit.org/reference/combobox) component can
+     * take over the composite widget responsibilities.
+     *
+     * Live examples:
+     * - [Menu with Combobox](https://ariakit.org/examples/menu-combobox)
+     * - [Select with Combobox](https://ariakit.org/examples/select-combobox)
      * @default true
      */
     composite?: boolean;
     /**
-     * Whether the active composite item should receive focus when `store.move` is
-     * called.
+     * Determines whether the composite widget should move focus to an item when
+     * arrow keys are pressed, given that the composite element is focused and
+     * there's no active item.
+     *
+     * **Note**: To entirely disable focus moving within a composite widget, you
+     * can use the
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) prop
+     * instead. If you want to control the behavior _only when arrow keys are
+     * pressed_, where
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) may
+     * not be applicable, this prop must be set on composite items as well.
      * @default true
+     * @example
+     * ```jsx
+     * <Composite moveOnKeyPress={false}>
+     *   <CompositeItem moveOnKeyPress={false} />
+     *   <CompositeItem moveOnKeyPress={false} />
+     * </Composite>
+     * ```
      */
-    focusOnMove?: boolean;
+    moveOnKeyPress?: BooleanOrCallback<ReactKeyboardEvent<HTMLElement>>;
     /**
-     * Whether the composite widget should move focus to an item when pressing
-     * arrow keys.
+     * Determines if the active composite item should receive focus (or virtual
+     * focus if the
+     * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+     * option is enabled) when moving through items. This typically happens when
+     * navigating through items with arrow keys, but it can also happen when
+     * calling the
+     * [`move`](https://ariakit.org/reference/use-composite-store#move) method
+     * directly.
+     *
+     * Unlike the
+     * [`composite`](https://ariakit.org/reference/composite#composite-1) prop,
+     * this option doesn't disable the entire composite widget behavior. It only
+     * stops this component from managing focus when navigating through items.
+     *
+     * **Note**: If you want to control the behavior only _when arrow keys are
+     * pressed_, use the
+     * [`moveOnKeyPress`](https://ariakit.org/reference/composite#moveonkeypress)
+     * prop instead.
      * @default true
      */
-    moveOnKeyPress?: BooleanOrCallback<ReactKeyboardEvent<HTMLElement>>;
+    focusOnMove?: boolean;
 }
 export type CompositeProps<T extends As = "div"> = Props<CompositeOptions<T>>;

package/cjs/composite/composite.d.ts

@@ -32,27 +32,82 @@ export declare const useComposite: import("../utils/types.js").Hook<CompositeOpt
 export declare const Composite: import("../utils/types.js").Component<CompositeOptions<"div">>;
 export interface CompositeOptions<T extends As = "div"> extends FocusableOptions<T> {
     /**
-     * Object returned by the `useCompositeStore` hook.
+     * Object returned by the
+     * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
+     * hook. If not provided, the closest
+     * [`CompositeProvider`](https://ariakit.org/reference/composite-provider)
+     * component's context will be used.
      */
     store?: CompositeStore;
     /**
-     * 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.
+     * Determines if the component should act as a composite widget. This prop
+     * needs to be set to `false` when merging various composite widgets where
+     * only one should function in that manner.
+     *
+     * If disabled, this component will stop managing focus and keyboard
+     * navigation for its items and itself. Additionally, composite ARIA
+     * attributes won't be applied. These responsibilities should be taken over by
+     * another composite component.
+     *
+     * **Note**: In most cases, this prop doesn't need to be set manually. For
+     * example, when composing [Menu with
+     * Combobox](https://ariakit.org/examples/menu-combobox) or [Select with
+     * Combobox](https://ariakit.org/examples/select-combobox), this prop will be
+     * set to `false` automatically on the
+     * [`Menu`](https://ariakit.org/reference/menu) and
+     * [`SelectPopover`](https://ariakit.org/reference/select-popover) components
+     * so the [`Combobox`](https://ariakit.org/reference/combobox) component can
+     * take over the composite widget responsibilities.
+     *
+     * Live examples:
+     * - [Menu with Combobox](https://ariakit.org/examples/menu-combobox)
+     * - [Select with Combobox](https://ariakit.org/examples/select-combobox)
      * @default true
      */
     composite?: boolean;
     /**
-     * Whether the active composite item should receive focus when `store.move` is
-     * called.
+     * Determines whether the composite widget should move focus to an item when
+     * arrow keys are pressed, given that the composite element is focused and
+     * there's no active item.
+     *
+     * **Note**: To entirely disable focus moving within a composite widget, you
+     * can use the
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) prop
+     * instead. If you want to control the behavior _only when arrow keys are
+     * pressed_, where
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) may
+     * not be applicable, this prop must be set on composite items as well.
      * @default true
+     * @example
+     * ```jsx
+     * <Composite moveOnKeyPress={false}>
+     *   <CompositeItem moveOnKeyPress={false} />
+     *   <CompositeItem moveOnKeyPress={false} />
+     * </Composite>
+     * ```
      */
-    focusOnMove?: boolean;
+    moveOnKeyPress?: BooleanOrCallback<ReactKeyboardEvent<HTMLElement>>;
     /**
-     * Whether the composite widget should move focus to an item when pressing
-     * arrow keys.
+     * Determines if the active composite item should receive focus (or virtual
+     * focus if the
+     * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+     * option is enabled) when moving through items. This typically happens when
+     * navigating through items with arrow keys, but it can also happen when
+     * calling the
+     * [`move`](https://ariakit.org/reference/use-composite-store#move) method
+     * directly.
+     *
+     * Unlike the
+     * [`composite`](https://ariakit.org/reference/composite#composite-1) prop,
+     * this option doesn't disable the entire composite widget behavior. It only
+     * stops this component from managing focus when navigating through items.
+     *
+     * **Note**: If you want to control the behavior only _when arrow keys are
+     * pressed_, use the
+     * [`moveOnKeyPress`](https://ariakit.org/reference/composite#moveonkeypress)
+     * prop instead.
      * @default true
      */
-    moveOnKeyPress?: BooleanOrCallback<ReactKeyboardEvent<HTMLElement>>;
+    focusOnMove?: boolean;
 }
 export type CompositeProps<T extends As = "div"> = Props<CompositeOptions<T>>;

package/cjs/dialog/dialog-disclosure.d.cts

@@ -14,7 +14,8 @@ import type { DialogStore } from "./dialog-store.js";
  */
 export declare const useDialogDisclosure: import("../utils/types.js").Hook<DialogDisclosureOptions<"button">>;
 /**
- * Renders a button that shows/hides a dialog.
+ * Renders a button that toggles the visibility of a
+ * [`Dialog`](https://ariakit.org/reference/dialog) component when clicked.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {2}

package/cjs/dialog/dialog-disclosure.d.ts

@@ -14,7 +14,8 @@ import type { DialogStore } from "./dialog-store.js";
  */
 export declare const useDialogDisclosure: import("../utils/types.js").Hook<DialogDisclosureOptions<"button">>;
 /**
- * Renders a button that shows/hides a dialog.
+ * Renders a button that toggles the visibility of a
+ * [`Dialog`](https://ariakit.org/reference/dialog) component when clicked.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {2}

package/cjs/dialog/dialog-dismiss.d.cts

@@ -15,7 +15,8 @@ import type { DialogStore } from "./dialog-store.js";
  */
 export declare const useDialogDismiss: import("../utils/types.js").Hook<DialogDismissOptions<"button">>;
 /**
- * Renders a button that hides a dialog.
+ * Renders a button that hides a
+ * [`Dialog`](https://ariakit.org/reference/dialog) when clicked.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {4}

package/cjs/dialog/dialog-dismiss.d.ts

@@ -15,7 +15,8 @@ import type { DialogStore } from "./dialog-store.js";
  */
 export declare const useDialogDismiss: import("../utils/types.js").Hook<DialogDismissOptions<"button">>;
 /**
- * Renders a button that hides a dialog.
+ * Renders a button that hides a
+ * [`Dialog`](https://ariakit.org/reference/dialog) when clicked.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {4}

package/cjs/dialog/dialog-provider.d.cts

@@ -1,7 +1,8 @@
 import type { ReactNode } from "react";
 import type { DialogStoreProps } from "./dialog-store.js";
 /**
- * Provides a dialog store to Dialog components.
+ * Provides a dialog store to [Dialog](https://ariakit.org/components/dialog)
+ * components.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx

package/cjs/dialog/dialog-provider.d.ts

@@ -1,7 +1,8 @@
 import type { ReactNode } from "react";
 import type { DialogStoreProps } from "./dialog-store.js";
 /**
- * Provides a dialog store to Dialog components.
+ * Provides a dialog store to [Dialog](https://ariakit.org/components/dialog)
+ * components.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx

package/cjs/dialog/dialog-store.d.cts

@@ -3,11 +3,13 @@ import type { DisclosureStoreFunctions, DisclosureStoreOptions, DisclosureStoreS
 import type { Store } from "../utils/store.js";
 export declare function useDialogStoreProps<T extends Core.DialogStore>(store: T, update: () => void, props: DialogStoreProps): T;
 /**
- * Creates a dialog store.
+ * Creates a dialog store to control the state of
+ * [Dialog](https://ariakit.org/components/dialog) components.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx
  * const dialog = useDialogStore();
+ *
  * <button onClick={dialog.toggle}>Open dialog</button>
  * <Dialog store={dialog}>Content</Dialog>
  * ```

package/cjs/dialog/dialog-store.d.ts

@@ -3,11 +3,13 @@ import type { DisclosureStoreFunctions, DisclosureStoreOptions, DisclosureStoreS
 import type { Store } from "../utils/store.js";
 export declare function useDialogStoreProps<T extends Core.DialogStore>(store: T, update: () => void, props: DialogStoreProps): T;
 /**
- * Creates a dialog store.
+ * Creates a dialog store to control the state of
+ * [Dialog](https://ariakit.org/components/dialog) components.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx
  * const dialog = useDialogStore();
+ *
  * <button onClick={dialog.toggle}>Open dialog</button>
  * <Dialog store={dialog}>Content</Dialog>
  * ```

package/cjs/dialog/dialog.cjs

@@ -3,9 +3,9 @@
 
 
 
-var _EKB76T2Ucjs = require('../__chunks/EKB76T2U.cjs');
+var _ZL5DC555cjs = require('../__chunks/ZL5DC555.cjs');
 require('../__chunks/WZ3DRKGP.cjs');
-require('../__chunks/NKR65BKC.cjs');
+require('../__chunks/KSPMHEYZ.cjs');
 require('../__chunks/PZL34OVO.cjs');
 require('../__chunks/344F3DYO.cjs');
 require('../__chunks/KREY6HXD.cjs');
@@ -13,11 +13,11 @@ require('../__chunks/5ZOCN23X.cjs');
 require('../__chunks/JVDUGICD.cjs');
 require('../__chunks/VV6WA3I6.cjs');
 require('../__chunks/7YLCVXZ7.cjs');
+require('../__chunks/5GTNIPQ6.cjs');
 require('../__chunks/7TN63K2T.cjs');
+require('../__chunks/V24PR4PW.cjs');
 require('../__chunks/6IUEXB4L.cjs');
 require('../__chunks/JF225FQ5.cjs');
-require('../__chunks/5GTNIPQ6.cjs');
-require('../__chunks/V24PR4PW.cjs');
 require('../__chunks/7566TIRW.cjs');
 require('../__chunks/J3OG6T3B.cjs');
 require('../__chunks/65LGW5LY.cjs');
@@ -42,4 +42,4 @@ require('../__chunks/AV6KTKLE.cjs');
 
 
 
-exports.Dialog = _EKB76T2Ucjs.Dialog; exports.createDialogComponent = _EKB76T2Ucjs.createDialogComponent; exports.useDialog = _EKB76T2Ucjs.useDialog;
+exports.Dialog = _ZL5DC555cjs.Dialog; exports.createDialogComponent = _ZL5DC555cjs.createDialogComponent; exports.useDialog = _ZL5DC555cjs.useDialog;