@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/dialog/dialog.d.cts

@@ -18,7 +18,14 @@ import type { DialogStore } from "./dialog-store.js";
 export declare const useDialog: import("../utils/types.js").Hook<DialogOptions<"div">>;
 export declare function createDialogComponent<T extends DialogOptions>(Component: Component<T>, useProviderContext?: () => DialogStore | undefined): Component<T>;
 /**
- * Renders a dialog element.
+ * Renders a dialog similar to the native `dialog` element that's rendered in a
+ * [`portal`](https://ariakit.org/reference/dialog#portal) by default.
+ *
+ * The dialog can be either
+ * [`modal`](https://ariakit.org/reference/dialog#modal) or non-modal. The
+ * visibility state can be controlled with the
+ * [`open`](https://ariakit.org/reference/dialog#open) and
+ * [`onClose`](https://ariakit.org/reference/dialog#onclose) props.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {4-6}
@@ -60,7 +67,7 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * 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. 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
@@ -87,14 +94,14 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * - 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`.
+     * - 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)
@@ -111,8 +118,10 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * 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.
+     * **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)
@@ -139,14 +148,27 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      */
     backdropProps?: ComponentPropsWithRef<"div">;
     /**
-     * Determines whether the dialog will be hidden when the user presses the
-     * Escape key.
+     * 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.
      * @default true
      */
     hideOnEscape?: BooleanOrCallback<KeyboardEvent | ReactKeyboardEvent>;
     /**
-     * Determines whether the dialog will be hidden when the user clicks or focus
-     * on an element outside of the 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)
@@ -154,11 +176,17 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      */
     hideOnInteractOutside?: BooleanOrCallback<Event | SyntheticEvent>;
     /**
-     * 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.
+     * 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
@@ -167,14 +195,17 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
     getPersistentElements?: () => Iterable<Element>;
     /**
      * Determines whether the body scrolling will be prevented when the dialog is
-     * shown.
+     * 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.
      */
     preventBodyScroll?: boolean;
     /**
      * 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.
+     * 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

package/cjs/dialog/dialog.d.ts

@@ -18,7 +18,14 @@ import type { DialogStore } from "./dialog-store.js";
 export declare const useDialog: import("../utils/types.js").Hook<DialogOptions<"div">>;
 export declare function createDialogComponent<T extends DialogOptions>(Component: Component<T>, useProviderContext?: () => DialogStore | undefined): Component<T>;
 /**
- * Renders a dialog element.
+ * Renders a dialog similar to the native `dialog` element that's rendered in a
+ * [`portal`](https://ariakit.org/reference/dialog#portal) by default.
+ *
+ * The dialog can be either
+ * [`modal`](https://ariakit.org/reference/dialog#modal) or non-modal. The
+ * visibility state can be controlled with the
+ * [`open`](https://ariakit.org/reference/dialog#open) and
+ * [`onClose`](https://ariakit.org/reference/dialog#onclose) props.
  * @see https://ariakit.org/components/dialog
  * @example
  * ```jsx {4-6}
@@ -60,7 +67,7 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * 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. 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
@@ -87,14 +94,14 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * - 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`.
+     * - 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)
@@ -111,8 +118,10 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      * 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.
+     * **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)
@@ -139,14 +148,27 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      */
     backdropProps?: ComponentPropsWithRef<"div">;
     /**
-     * Determines whether the dialog will be hidden when the user presses the
-     * Escape key.
+     * 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.
      * @default true
      */
     hideOnEscape?: BooleanOrCallback<KeyboardEvent | ReactKeyboardEvent>;
     /**
-     * Determines whether the dialog will be hidden when the user clicks or focus
-     * on an element outside of the 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)
@@ -154,11 +176,17 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
      */
     hideOnInteractOutside?: BooleanOrCallback<Event | SyntheticEvent>;
     /**
-     * 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.
+     * 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
@@ -167,14 +195,17 @@ export interface DialogOptions<T extends As = "div"> extends FocusableOptions<T>
     getPersistentElements?: () => Iterable<Element>;
     /**
      * Determines whether the body scrolling will be prevented when the dialog is
-     * shown.
+     * 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.
      */
     preventBodyScroll?: boolean;
     /**
      * 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.
+     * 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

package/cjs/dialog/utils/disable-tree.cjs

@@ -2,14 +2,14 @@
 
 
 
-var _NKR65BKCcjs = require('../../__chunks/NKR65BKC.cjs');
+var _KSPMHEYZcjs = require('../../__chunks/KSPMHEYZ.cjs');
 require('../../__chunks/PZL34OVO.cjs');
 require('../../__chunks/7YLCVXZ7.cjs');
-require('../../__chunks/6IUEXB4L.cjs');
 require('../../__chunks/5GTNIPQ6.cjs');
 require('../../__chunks/V24PR4PW.cjs');
+require('../../__chunks/6IUEXB4L.cjs');
 require('../../__chunks/AV6KTKLE.cjs');
 
 
 
-exports.disableTree = _NKR65BKCcjs.disableTree; exports.disableTreeOutside = _NKR65BKCcjs.disableTreeOutside;
+exports.disableTree = _KSPMHEYZcjs.disableTree; exports.disableTreeOutside = _KSPMHEYZcjs.disableTreeOutside;

package/cjs/dialog/utils/use-hide-on-interact-outside.cjs

@@ -4,8 +4,8 @@
 var _JVDUGICDcjs = require('../../__chunks/JVDUGICD.cjs');
 require('../../__chunks/VV6WA3I6.cjs');
 require('../../__chunks/7YLCVXZ7.cjs');
-require('../../__chunks/7TN63K2T.cjs');
 require('../../__chunks/5GTNIPQ6.cjs');
+require('../../__chunks/7TN63K2T.cjs');
 require('../../__chunks/V24PR4PW.cjs');
 require('../../__chunks/EO6LS72H.cjs');
 require('../../__chunks/CJDHQUBR.cjs');

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

@@ -14,10 +14,11 @@ export declare function isHidden(mounted: boolean, hidden?: boolean | null, alwa
  */
 export declare const useDisclosureContent: import("../utils/types.js").Hook<DisclosureContentOptions<"div">>;
 /**
- * Renders an element that can be shown or hidden.
+ * Renders an element that can be shown or hidden by a
+ * [`Disclosure`](https://ariakit.org/components/disclosure) component.
  * @see https://ariakit.org/components/disclosure
  * @example
- * ```jsx
+ * ```jsx {3}
  * <DisclosureProvider>
  *   <Disclosure>Disclosure</Disclosure>
  *   <DisclosureContent>Content</DisclosureContent>
@@ -36,9 +37,9 @@ export interface DisclosureContentOptions<T extends As = "div"> extends Options<
     store?: DisclosureStore;
     /**
      * 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.
+     * [`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

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

@@ -14,10 +14,11 @@ export declare function isHidden(mounted: boolean, hidden?: boolean | null, alwa
  */
 export declare const useDisclosureContent: import("../utils/types.js").Hook<DisclosureContentOptions<"div">>;
 /**
- * Renders an element that can be shown or hidden.
+ * Renders an element that can be shown or hidden by a
+ * [`Disclosure`](https://ariakit.org/components/disclosure) component.
  * @see https://ariakit.org/components/disclosure
  * @example
- * ```jsx
+ * ```jsx {3}
  * <DisclosureProvider>
  *   <Disclosure>Disclosure</Disclosure>
  *   <DisclosureContent>Content</DisclosureContent>
@@ -36,9 +37,9 @@ export interface DisclosureContentOptions<T extends As = "div"> extends Options<
     store?: DisclosureStore;
     /**
      * 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.
+     * [`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

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

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

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

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

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

@@ -2,11 +2,13 @@ import * as Core from "@ariakit/core/disclosure/disclosure-store";
 import type { Store } from "../utils/store.js";
 export declare function useDisclosureStoreProps<T extends Core.DisclosureStore>(store: T, update: () => void, props: DisclosureStoreProps): T;
 /**
- * Creates a disclosure store.
+ * Creates a disclosure store to control the state of
+ * [Disclosure](https://ariakit.org/components/disclosure) components.
  * @see https://ariakit.org/components/disclosure
  * @example
  * ```jsx
  * const disclosure = useDisclosureStore();
+ *
  * <Disclosure store={disclosure}>Disclosure</Disclosure>
  * <DisclosureContent store={disclosure}>Content</DisclosureContent>
  * ```
@@ -18,8 +20,9 @@ export interface DisclosureStoreFunctions extends Core.DisclosureStoreFunctions
 }
 export interface DisclosureStoreOptions extends Core.DisclosureStoreOptions {
     /**
-     * A callback that gets called when the `open` state changes.
-     * @param open The new open value.
+     * A callback that gets called when the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) state
+     * changes.
      * @example
      * const [open, setOpen] = useState(false);
      * const disclosure = useDisclosureStore({ open, setOpen });
@@ -27,7 +30,6 @@ export interface DisclosureStoreOptions extends Core.DisclosureStoreOptions {
     setOpen?: (open: DisclosureStoreState["open"]) => void;
     /**
      * 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 });

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

@@ -2,11 +2,13 @@ import * as Core from "@ariakit/core/disclosure/disclosure-store";
 import type { Store } from "../utils/store.js";
 export declare function useDisclosureStoreProps<T extends Core.DisclosureStore>(store: T, update: () => void, props: DisclosureStoreProps): T;
 /**
- * Creates a disclosure store.
+ * Creates a disclosure store to control the state of
+ * [Disclosure](https://ariakit.org/components/disclosure) components.
  * @see https://ariakit.org/components/disclosure
  * @example
  * ```jsx
  * const disclosure = useDisclosureStore();
+ *
  * <Disclosure store={disclosure}>Disclosure</Disclosure>
  * <DisclosureContent store={disclosure}>Content</DisclosureContent>
  * ```
@@ -18,8 +20,9 @@ export interface DisclosureStoreFunctions extends Core.DisclosureStoreFunctions
 }
 export interface DisclosureStoreOptions extends Core.DisclosureStoreOptions {
     /**
-     * A callback that gets called when the `open` state changes.
-     * @param open The new open value.
+     * A callback that gets called when the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) state
+     * changes.
      * @example
      * const [open, setOpen] = useState(false);
      * const disclosure = useDisclosureStore({ open, setOpen });
@@ -27,7 +30,6 @@ export interface DisclosureStoreOptions extends Core.DisclosureStoreOptions {
     setOpen?: (open: DisclosureStoreState["open"]) => void;
     /**
      * 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 });

package/cjs/disclosure/disclosure.d.cts

@@ -16,11 +16,12 @@ import type { DisclosureStore } from "./disclosure-store.js";
  */
 export declare const useDisclosure: import("../utils/types.js").Hook<DisclosureOptions<"button">>;
 /**
- * Renders an element that controls the visibility of a disclosure content
+ * Renders an element that controls the visibility of a
+ * [`DisclosureContent`](https://ariakit.org/reference/disclosure-content)
  * element.
  * @see https://ariakit.org/components/disclosure
  * @example
- * ```jsx
+ * ```jsx {2}
  * <DisclosureProvider>
  *   <Disclosure>Disclosure</Disclosure>
  *   <DisclosureContent>Content</DisclosureContent>

package/cjs/disclosure/disclosure.d.ts

@@ -16,11 +16,12 @@ import type { DisclosureStore } from "./disclosure-store.js";
  */
 export declare const useDisclosure: import("../utils/types.js").Hook<DisclosureOptions<"button">>;
 /**
- * Renders an element that controls the visibility of a disclosure content
+ * Renders an element that controls the visibility of a
+ * [`DisclosureContent`](https://ariakit.org/reference/disclosure-content)
  * element.
  * @see https://ariakit.org/components/disclosure
  * @example
- * ```jsx
+ * ```jsx {2}
  * <DisclosureProvider>
  *   <Disclosure>Disclosure</Disclosure>
  *   <DisclosureContent>Content</DisclosureContent>

package/cjs/focus-trap/focus-trap-region.d.cts

@@ -10,8 +10,10 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusTrapRegion: import("../utils/types.js").Hook<FocusTrapRegionOptions<"div">>;
 /**
- * Renders a focus trap region element.
- * @see https://ariakit.org/components/focus-trap-region
+ * Renders a wrapper element that traps the focus inside it when the
+ * [`enabled`](https://ariakit.org/reference/focus-trap-region#enabled) prop is
+ * `true`.
+ * @see https://ariakit.org/components/focus-trap
  * @example
  * ```jsx
  * <FocusTrapRegion>

package/cjs/focus-trap/focus-trap-region.d.ts

@@ -10,8 +10,10 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusTrapRegion: import("../utils/types.js").Hook<FocusTrapRegionOptions<"div">>;
 /**
- * Renders a focus trap region element.
- * @see https://ariakit.org/components/focus-trap-region
+ * Renders a wrapper element that traps the focus inside it when the
+ * [`enabled`](https://ariakit.org/reference/focus-trap-region#enabled) prop is
+ * `true`.
+ * @see https://ariakit.org/components/focus-trap
  * @example
  * ```jsx
  * <FocusTrapRegion>

package/cjs/focusable/focusable-container.d.cts

@@ -10,8 +10,9 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusableContainer: import("../utils/types.js").Hook<FocusableContainerOptions<"div">>;
 /**
- * Renders a div that wraps `Focusable` components and controls whether they
- * can be auto focused.
+ * Renders a div that wraps
+ * [`Focusable`](https://ariakit.org/reference/focusable) components and
+ * controls whether they can be auto-focused.
  * @see https://ariakit.org/components/focusable
  * @example
  * ```jsx
@@ -23,9 +24,10 @@ export declare const useFocusableContainer: import("../utils/types.js").Hook<Foc
 export declare const FocusableContainer: import("../utils/types.js").Component<FocusableContainerOptions<"div">>;
 export type FocusableContainerOptions<T extends As = "div"> = Options<T> & {
     /**
-     * Determines whether focusable elements inside the container should be
-     * automatically focused when the container is shown and they have the
-     * `autoFocus` prop.
+     * Determines whether [`Focusable`](https://ariakit.org/reference/focusable)
+     * elements inside the container should be automatically focused when the
+     * container is shown and they have the
+     * [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.
      * @default true
      */
     autoFocusOnShow?: boolean;

package/cjs/focusable/focusable-container.d.ts

@@ -10,8 +10,9 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusableContainer: import("../utils/types.js").Hook<FocusableContainerOptions<"div">>;
 /**
- * Renders a div that wraps `Focusable` components and controls whether they
- * can be auto focused.
+ * Renders a div that wraps
+ * [`Focusable`](https://ariakit.org/reference/focusable) components and
+ * controls whether they can be auto-focused.
  * @see https://ariakit.org/components/focusable
  * @example
  * ```jsx
@@ -23,9 +24,10 @@ export declare const useFocusableContainer: import("../utils/types.js").Hook<Foc
 export declare const FocusableContainer: import("../utils/types.js").Component<FocusableContainerOptions<"div">>;
 export type FocusableContainerOptions<T extends As = "div"> = Options<T> & {
     /**
-     * Determines whether focusable elements inside the container should be
-     * automatically focused when the container is shown and they have the
-     * `autoFocus` prop.
+     * Determines whether [`Focusable`](https://ariakit.org/reference/focusable)
+     * elements inside the container should be automatically focused when the
+     * container is shown and they have the
+     * [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.
      * @default true
      */
     autoFocusOnShow?: boolean;

package/cjs/focusable/focusable.d.cts

@@ -46,6 +46,7 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
      * 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)
      * @default false
      */
     disabled?: boolean;
@@ -109,8 +110,10 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
     accessibleWhenDisabled?: boolean;
     /**
      * 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.
+     * 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.
      *
      * Live examples:
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)

package/cjs/focusable/focusable.d.ts

@@ -46,6 +46,7 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
      * 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)
      * @default false
      */
     disabled?: boolean;
@@ -109,8 +110,10 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
     accessibleWhenDisabled?: boolean;
     /**
      * 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.
+     * 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.
      *
      * Live examples:
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)

package/cjs/form/form-checkbox.cjs

@@ -1,17 +1,17 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _VCDQISP7cjs = require('../__chunks/VCDQISP7.cjs');
+var _N3XK7EAHcjs = require('../__chunks/N3XK7EAH.cjs');
 
 
 var _FROYTN4Bcjs = require('../__chunks/FROYTN4B.cjs');
 
 
-var _BBS4RP44cjs = require('../__chunks/BBS4RP44.cjs');
-require('../__chunks/63UPRTFZ.cjs');
+var _VPQQSYH7cjs = require('../__chunks/VPQQSYH7.cjs');
 
 
-var _VPQQSYH7cjs = require('../__chunks/VPQQSYH7.cjs');
+var _BBS4RP44cjs = require('../__chunks/BBS4RP44.cjs');
+require('../__chunks/63UPRTFZ.cjs');
 require('../__chunks/ERFHNHON.cjs');
 require('../__chunks/DAJUUBUI.cjs');
 require('../__chunks/R5A2WTWB.cjs');
@@ -48,7 +48,7 @@ var useFormCheckbox = _RNZNGEL4cjs.createHook.call(void 0,
       setValue: (value2) => store == null ? void 0 : store.setValue(name, value2)
     });
     props = _BBS4RP44cjs.useCheckbox.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, { store: checkboxStore, value, checked }, props));
-    props = _VCDQISP7cjs.useFormField.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
+    props = _N3XK7EAHcjs.useFormControl.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
       store,
       name,
       "aria-labelledby": void 0