@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/composite/composite-group-label.d.ts

@@ -16,26 +16,31 @@ import type { CompositeStore } from "./composite-store.js";
 export declare const useCompositeGroupLabel: import("../utils/types.js").Hook<CompositeGroupLabelOptions<"div">>;
 /**
  * Renders a label in a composite group. This component must be wrapped with
- * `CompositeGroup` so the `aria-labelledby` prop is properly set on the
- * composite group element.
+ * [`CompositeGroup`](https://ariakit.org/reference/composite-group) so the
+ * `aria-labelledby` prop is properly set on the group element.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeGroup>
- *     <CompositeGroupLabel>Label</CompositeGroupLabel>
- *     <CompositeItem>Item 1</CompositeItem>
- *     <CompositeItem>Item 2</CompositeItem>
- *   </CompositeGroup>
- * </Composite>
+ * ```jsx {4}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeGroup>
+ *       <CompositeGroupLabel>Label</CompositeGroupLabel>
+ *       <CompositeItem>Item 1</CompositeItem>
+ *       <CompositeItem>Item 2</CompositeItem>
+ *     </CompositeGroup>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeGroupLabel: import("../utils/types.js").Component<CompositeGroupLabelOptions<"div">>;
 export interface CompositeGroupLabelOptions<T extends As = "div"> extends GroupLabelOptions<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-group.d.cts

@@ -19,25 +19,33 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeGroup: import("../utils/types.js").Hook<CompositeGroupOptions<"div">>;
 /**
- * Renders a group element for composite items.
+ * Renders a group element for composite items. The
+ * [`CompositeGroupLabel`](https://ariakit.org/reference/composite-group-label)
+ * component can be used inside this component so the `aria-labelledby` prop is
+ * properly set on the group element.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeGroup>
- *     <CompositeGroupLabel>Label</CompositeGroupLabel>
- *     <CompositeItem>Item 1</CompositeItem>
- *     <CompositeItem>Item 2</CompositeItem>
- *   </CompositeGroup>
- * </Composite>
+ * ```jsx {3-7}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeGroup>
+ *       <CompositeGroupLabel>Label</CompositeGroupLabel>
+ *       <CompositeItem>Item 1</CompositeItem>
+ *       <CompositeItem>Item 2</CompositeItem>
+ *     </CompositeGroup>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeGroup: import("../utils/types.js").Component<CompositeGroupOptions<"div">>;
 export interface CompositeGroupOptions<T extends As = "div"> extends GroupOptions<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-group.d.ts

@@ -19,25 +19,33 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeGroup: import("../utils/types.js").Hook<CompositeGroupOptions<"div">>;
 /**
- * Renders a group element for composite items.
+ * Renders a group element for composite items. The
+ * [`CompositeGroupLabel`](https://ariakit.org/reference/composite-group-label)
+ * component can be used inside this component so the `aria-labelledby` prop is
+ * properly set on the group element.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeGroup>
- *     <CompositeGroupLabel>Label</CompositeGroupLabel>
- *     <CompositeItem>Item 1</CompositeItem>
- *     <CompositeItem>Item 2</CompositeItem>
- *   </CompositeGroup>
- * </Composite>
+ * ```jsx {3-7}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeGroup>
+ *       <CompositeGroupLabel>Label</CompositeGroupLabel>
+ *       <CompositeItem>Item 1</CompositeItem>
+ *       <CompositeItem>Item 2</CompositeItem>
+ *     </CompositeGroup>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeGroup: import("../utils/types.js").Component<CompositeGroupOptions<"div">>;
 export interface CompositeGroupOptions<T extends As = "div"> extends GroupOptions<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-hover.d.cts

@@ -19,16 +19,25 @@ import type { CompositeStore } from "./composite-store.js";
 export declare const useCompositeHover: import("../utils/types.js").Hook<CompositeHoverOptions<"div">>;
 /**
  * Renders an element in a composite widget that receives focus on mouse move
- * and loses focus to the composite base element on mouse leave. This should be
- * combined with the `CompositeItem` component, the `useCompositeItem` hook or
- * any component/hook that uses them underneath.
+ * and loses focus to the composite base element on mouse leave.
+ *
+ * This should be combined with the
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) component.
+ * The
+ * [`focusOnHover`](https://ariakit.org/reference/composite-hover#focusonhover)
+ * and
+ * [`blurOnHoverEnd`](https://ariakit.org/reference/composite-hover#bluronhoverend)
+ * props can be used to customize the behavior.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeHover render={<CompositeItem />}>Item</CompositeHover>
- * </Composite>
+ * ```jsx {3-5}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeHover render={<CompositeItem />}>
+ *       Item
+ *     </CompositeHover>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeHover: import("../utils/types.js").Component<CompositeHoverOptions<"div">>;

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

@@ -19,16 +19,25 @@ import type { CompositeStore } from "./composite-store.js";
 export declare const useCompositeHover: import("../utils/types.js").Hook<CompositeHoverOptions<"div">>;
 /**
  * Renders an element in a composite widget that receives focus on mouse move
- * and loses focus to the composite base element on mouse leave. This should be
- * combined with the `CompositeItem` component, the `useCompositeItem` hook or
- * any component/hook that uses them underneath.
+ * and loses focus to the composite base element on mouse leave.
+ *
+ * This should be combined with the
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) component.
+ * The
+ * [`focusOnHover`](https://ariakit.org/reference/composite-hover#focusonhover)
+ * and
+ * [`blurOnHoverEnd`](https://ariakit.org/reference/composite-hover#bluronhoverend)
+ * props can be used to customize the behavior.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeHover render={<CompositeItem />}>Item</CompositeHover>
- * </Composite>
+ * ```jsx {3-5}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeHover render={<CompositeItem />}>
+ *       Item
+ *     </CompositeHover>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeHover: import("../utils/types.js").Component<CompositeHoverOptions<"div">>;

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

@@ -17,22 +17,28 @@ import type { CompositeStore } from "./composite-store.js";
 export declare const useCompositeInput: import("../utils/types.js").Hook<CompositeInputOptions<"input">>;
 /**
  * Renders an input as a composite item. This should be used in conjunction with
- * the `CompositeItem` component or a component that uses `CompositeItem`
- * underneath.
+ * the [`CompositeItem`](https://ariakit.org/reference/composite-item) component
+ * or a component that uses
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) underneath.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem render={<CompositeInput />} />
- * </Composite>
+ * ```jsx {3}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem render={<CompositeInput />} />
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeInput: import("../utils/types.js").Component<CompositeInputOptions<"input">>;
 export interface CompositeInputOptions<T extends As = "input"> 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-input.d.ts

@@ -17,22 +17,28 @@ import type { CompositeStore } from "./composite-store.js";
 export declare const useCompositeInput: import("../utils/types.js").Hook<CompositeInputOptions<"input">>;
 /**
  * Renders an input as a composite item. This should be used in conjunction with
- * the `CompositeItem` component or a component that uses `CompositeItem`
- * underneath.
+ * the [`CompositeItem`](https://ariakit.org/reference/composite-item) component
+ * or a component that uses
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) underneath.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem render={<CompositeInput />} />
- * </Composite>
+ * ```jsx {3}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem render={<CompositeInput />} />
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeInput: import("../utils/types.js").Component<CompositeInputOptions<"input">>;
 export interface CompositeInputOptions<T extends As = "input"> 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-item.d.cts

@@ -16,16 +16,27 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeItem: import("../utils/types.js").Hook<CompositeItemOptions<"button">>;
 /**
- * Renders a composite item.
+ * Renders a focusable item as part of a composite widget. The `tabindex`
+ * attribute is automatically managed by this component based on the
+ * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+ * option.
+ *
+ * When this component receives DOM focus or is virtually focused (when the
+ * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+ * option is set to `true`), the element will automatically receive the
+ * [`data-active-item`](https://ariakit.org/guide/styling#data-active-item)
+ * attribute. This can be used to style the focused item, no matter the focus
+ * approach employed.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeItem>Item 2</CompositeItem>
- *   <CompositeItem>Item 3</CompositeItem>
- * </Composite>
+ * ```jsx {3-5}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeItem>Item 2</CompositeItem>
+ *     <CompositeItem>Item 3</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeItem: import("../utils/types.js").Component<CompositeItemOptions<"button">>;
@@ -39,6 +50,14 @@ export interface CompositeItemOptions<T extends As = "button"> extends CommandOp
      * components' context will be used.
      */
     store?: CompositeStore;
+    /**
+     * Determines if the item should be registered as part of the collection. If
+     * this is set to `false`, the item won't be accessible via arrow keys.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
+     */
+    shouldRegisterItem?: CollectionItemOptions<T>["shouldRegisterItem"];
     /**
      * The id that will be used to group items in the same row. This is usually
      * retrieved by the
@@ -49,12 +68,33 @@ export interface CompositeItemOptions<T extends As = "button"> extends CommandOp
     /**
      * Whether the scroll behavior should be prevented when pressing arrow keys on
      * the first or the last items.
+     * @deprecated Use CSS
+     * [`scroll-margin`](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin)
+     * instead.
      * @default false
      */
     preventScrollOnKeyDown?: BooleanOrCallback<KeyboardEvent<HTMLElement>>;
     /**
-     * Whether pressing arrow keys should move the focus to a different item.
+     * Determines if pressing arrow keys while this item is in focus should move
+     * focus to a different item.
+     *
+     * **Note**: To entirely disable focus moving within a composite widget, you
+     * can use the
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) prop
+     * on the composite component 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 all composite items because
+     * they each manage their own key presses, as well as on the composite
+     * component itself.
      * @default true
+     * @example
+     * ```jsx
+     * <Composite moveOnKeyPress={false}>
+     *   <CompositeItem moveOnKeyPress={false} />
+     *   <CompositeItem moveOnKeyPress={false} />
+     * </Composite>
+     * ```
      */
     moveOnKeyPress?: BooleanOrCallback<KeyboardEvent<HTMLElement>>;
     /**

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

@@ -16,16 +16,27 @@ import type { CompositeStore } from "./composite-store.js";
  */
 export declare const useCompositeItem: import("../utils/types.js").Hook<CompositeItemOptions<"button">>;
 /**
- * Renders a composite item.
+ * Renders a focusable item as part of a composite widget. The `tabindex`
+ * attribute is automatically managed by this component based on the
+ * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+ * option.
+ *
+ * When this component receives DOM focus or is virtually focused (when the
+ * [`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)
+ * option is set to `true`), the element will automatically receive the
+ * [`data-active-item`](https://ariakit.org/guide/styling#data-active-item)
+ * attribute. This can be used to style the focused item, no matter the focus
+ * approach employed.
  * @see https://ariakit.org/components/composite
  * @example
- * ```jsx
- * const composite = useCompositeStore();
- * <Composite store={composite}>
- *   <CompositeItem>Item 1</CompositeItem>
- *   <CompositeItem>Item 2</CompositeItem>
- *   <CompositeItem>Item 3</CompositeItem>
- * </Composite>
+ * ```jsx {3-5}
+ * <CompositeProvider>
+ *   <Composite>
+ *     <CompositeItem>Item 1</CompositeItem>
+ *     <CompositeItem>Item 2</CompositeItem>
+ *     <CompositeItem>Item 3</CompositeItem>
+ *   </Composite>
+ * </CompositeProvider>
  * ```
  */
 export declare const CompositeItem: import("../utils/types.js").Component<CompositeItemOptions<"button">>;
@@ -39,6 +50,14 @@ export interface CompositeItemOptions<T extends As = "button"> extends CommandOp
      * components' context will be used.
      */
     store?: CompositeStore;
+    /**
+     * Determines if the item should be registered as part of the collection. If
+     * this is set to `false`, the item won't be accessible via arrow keys.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
+     */
+    shouldRegisterItem?: CollectionItemOptions<T>["shouldRegisterItem"];
     /**
      * The id that will be used to group items in the same row. This is usually
      * retrieved by the
@@ -49,12 +68,33 @@ export interface CompositeItemOptions<T extends As = "button"> extends CommandOp
     /**
      * Whether the scroll behavior should be prevented when pressing arrow keys on
      * the first or the last items.
+     * @deprecated Use CSS
+     * [`scroll-margin`](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-margin)
+     * instead.
      * @default false
      */
     preventScrollOnKeyDown?: BooleanOrCallback<KeyboardEvent<HTMLElement>>;
     /**
-     * Whether pressing arrow keys should move the focus to a different item.
+     * Determines if pressing arrow keys while this item is in focus should move
+     * focus to a different item.
+     *
+     * **Note**: To entirely disable focus moving within a composite widget, you
+     * can use the
+     * [`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) prop
+     * on the composite component 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 all composite items because
+     * they each manage their own key presses, as well as on the composite
+     * component itself.
      * @default true
+     * @example
+     * ```jsx
+     * <Composite moveOnKeyPress={false}>
+     *   <CompositeItem moveOnKeyPress={false} />
+     *   <CompositeItem moveOnKeyPress={false} />
+     * </Composite>
+     * ```
      */
     moveOnKeyPress?: BooleanOrCallback<KeyboardEvent<HTMLElement>>;
     /**

package/cjs/composite/composite-overflow.cjs

@@ -1,10 +1,10 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _KDG57VZVcjs = require('../__chunks/KDG57VZV.cjs');
-require('../__chunks/EKB76T2U.cjs');
+var _OUEE5HOScjs = require('../__chunks/OUEE5HOS.cjs');
+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');
@@ -12,11 +12,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');
@@ -91,7 +91,7 @@ var useCompositeOverflow = _RNZNGEL4cjs.createHook.call(void 0,
     }, props), {
       onFocus
     });
-    props = _KDG57VZVcjs.usePopover.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
+    props = _OUEE5HOScjs.usePopover.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
       store,
       backdropProps,
       wrapperProps,

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

@@ -2,7 +2,8 @@ import type { ReactElement, ReactNode } from "react";
 import type { PickRequired } from "@ariakit/core/utils/types";
 import type { CompositeStoreItem, CompositeStoreProps } from "./composite-store.js";
 /**
- * Provides a composite store to CompositeItem components.
+ * Provides a composite store to
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) components.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx

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

@@ -2,7 +2,8 @@ import type { ReactElement, ReactNode } from "react";
 import type { PickRequired } from "@ariakit/core/utils/types";
 import type { CompositeStoreItem, CompositeStoreProps } from "./composite-store.js";
 /**
- * Provides a composite store to CompositeItem components.
+ * Provides a composite store to
+ * [`CompositeItem`](https://ariakit.org/reference/composite-item) components.
  * @see https://ariakit.org/components/composite
  * @example
  * ```jsx

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

@@ -294,7 +294,7 @@ export interface CompositeRendererOptions<T extends Item = any> extends Omit<Col
     /**
      * Object returned by the
      * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [Composite](https://ariakit.org/components/composite) component's context
      * will be used.
      *

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

@@ -294,7 +294,7 @@ export interface CompositeRendererOptions<T extends Item = any> extends Omit<Col
     /**
      * Object returned by the
      * [`useCompositeStore`](https://ariakit.org/reference/use-composite-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [Composite](https://ariakit.org/components/composite) component's context
      * will be used.
      *

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

@@ -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;
 }