@ariakit/react-core 0.3.11 → 0.3.13

package/esm/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">>;
@@ -60,6 +69,7 @@ export interface CompositeHoverOptions<T extends As = "div"> extends Options<T>
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      * @default true
      */
     focusOnHover?: BooleanOrCallback<ReactMouseEvent<HTMLElement>>;
@@ -75,6 +85,7 @@ export interface CompositeHoverOptions<T extends As = "div"> extends Options<T>
      *   filter](https://ariakit.org/examples/combobox-filtering-integrated)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     blurOnHoverEnd?: BooleanOrCallback<ReactMouseEvent<HTMLElement>>;
 }

package/esm/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/esm/composite/composite-input.js

@@ -2,8 +2,8 @@
 import {
   CompositeInput,
   useCompositeInput
-} from "../__chunks/UP4ONTQS.js";
-import "../__chunks/6QXBPV75.js";
+} from "../__chunks/I4Q3C2VT.js";
+import "../__chunks/3IEDWLST.js";
 import "../__chunks/3ORBWXWF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";

package/esm/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/esm/composite/composite-item.js

@@ -2,16 +2,16 @@
 import {
   CompositeItem,
   useCompositeItem
-} from "../__chunks/R2WNOXYG.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/W7TET3D7.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/UH3I23HL.js";
-import "../__chunks/6QXBPV75.js";
+import "../__chunks/3IEDWLST.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/composite/composite-overflow-disclosure.js

@@ -1,30 +1,30 @@
 "use client";
 import {
   usePopoverDisclosure
-} from "../__chunks/4ZEZYKUR.js";
-import "../__chunks/H3TG2CZP.js";
-import "../__chunks/BHEJ6NUH.js";
+} from "../__chunks/PHR7QED4.js";
+import "../__chunks/PUBUTPR6.js";
+import "../__chunks/CM2MGWJJ.js";
 import "../__chunks/JCH6MLL2.js";
-import "../__chunks/VDNZBO4W.js";
+import "../__chunks/JH4A3V7P.js";
 import {
   useCompositeItem
-} from "../__chunks/R2WNOXYG.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/W7TET3D7.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/UH3I23HL.js";
-import "../__chunks/6QXBPV75.js";
+import "../__chunks/3IEDWLST.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/7H5KSHHF.js";
 import "../__chunks/G6BJYYBK.js";
 import "../__chunks/OAYFXAQ2.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,
   createElement,
   createHook
 } from "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import {
   useEvent,
   useMergeRefs

package/esm/composite/composite-overflow-store.js

@@ -1,12 +1,12 @@
 "use client";
 import {
   usePopoverStoreProps
-} from "../__chunks/EENTNM7A.js";
-import "../__chunks/6SB7F42L.js";
-import "../__chunks/SMM5JVLC.js";
+} from "../__chunks/MG4P3223.js";
+import "../__chunks/ZSELSBRM.js";
+import "../__chunks/SFCBA2JZ.js";
 import {
   useStore
-} from "../__chunks/4OZYHFMH.js";
+} from "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/composite/composite-overflow.js

@@ -1,10 +1,10 @@
 "use client";
 import {
   usePopover
-} from "../__chunks/SXPADS2D.js";
-import "../__chunks/PDVJHECS.js";
-import "../__chunks/57VLL43X.js";
-import "../__chunks/CLF4PQ7T.js";
+} from "../__chunks/A2OYJMGS.js";
+import "../__chunks/SNX6RSV7.js";
+import "../__chunks/LWHPHW7Q.js";
+import "../__chunks/TQYOGOE2.js";
 import "../__chunks/BULCTPRV.js";
 import "../__chunks/6BJGLK2C.js";
 import "../__chunks/CS347UVZ.js";
@@ -12,11 +12,11 @@ import "../__chunks/IUB2BTEK.js";
 import "../__chunks/XHJGS6Z5.js";
 import "../__chunks/TL67WVI6.js";
 import "../__chunks/MKDDWKFK.js";
+import "../__chunks/72E5EPFF.js";
 import "../__chunks/OOBDFMJL.js";
+import "../__chunks/X6WIMZJE.js";
 import "../__chunks/677M2CI3.js";
 import "../__chunks/6GXEOXGT.js";
-import "../__chunks/72E5EPFF.js";
-import "../__chunks/X6WIMZJE.js";
 import "../__chunks/HPP6CWMY.js";
 import "../__chunks/UYRJLDVS.js";
 import "../__chunks/JPXNJYSO.js";
@@ -24,11 +24,11 @@ import "../__chunks/CHKJ74UC.js";
 import "../__chunks/7452U3HH.js";
 import "../__chunks/XPF5GU3Q.js";
 import "../__chunks/FSFPRQFR.js";
-import "../__chunks/KOKHD3Z3.js";
+import "../__chunks/CLE7NTOY.js";
 import "../__chunks/7H5KSHHF.js";
 import "../__chunks/G6BJYYBK.js";
 import "../__chunks/OAYFXAQ2.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import "../__chunks/BG6HZDS7.js";
 import {
@@ -36,9 +36,9 @@ import {
   createElement,
   createHook
 } from "../__chunks/3ORBWXWF.js";
-import "../__chunks/6SB7F42L.js";
-import "../__chunks/SMM5JVLC.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/ZSELSBRM.js";
+import "../__chunks/SFCBA2JZ.js";
+import "../__chunks/EKQEJRUF.js";
 import {
   useEvent
 } from "../__chunks/6O5OEQGF.js";

package/esm/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/esm/composite/composite-provider.js

@@ -1,14 +1,14 @@
 "use client";
 import {
   useCompositeStore
-} from "../__chunks/A6ER4BO6.js";
-import "../__chunks/HDMIVTNE.js";
+} from "../__chunks/7GBW5FLS.js";
+import "../__chunks/Y6GYTNQ2.js";
 import {
   CompositeContextProvider
 } from "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/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/esm/composite/composite-renderer.js

@@ -2,15 +2,15 @@
 import {
   CompositeRenderer,
   useCompositeRenderer
-} from "../__chunks/6L5IUFNE.js";
+} from "../__chunks/KSKI4NLV.js";
 import {
   getCollectionRendererItem,
   getCollectionRendererItemId
-} from "../__chunks/GD2VG2KJ.js";
+} from "../__chunks/4HD64GHO.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/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/esm/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/esm/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>
@@ -26,11 +28,12 @@ export interface CompositeStoreFunctions<T extends CompositeStoreItem = Composit
 }
 export interface CompositeStoreOptions<T extends CompositeStoreItem = CompositeStoreItem> extends Core.CompositeStoreOptions<T>, CollectionStoreOptions<T> {
     /**
-     * A callback that gets called when the `activeId` state changes.
-     * @param activeId The new active id.
-     * @example
-     * const [activeId, setActiveId] = useState(null);
-     * const composite = useCompositeStore({ activeId, setActiveId });
+     * A callback that gets called when the
+     * [`activeId`](https://ariakit.org/reference/composite-provider#activeid)
+     * state changes.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     setActiveId?: (activeId: CompositeStoreState<T>["activeId"]) => void;
 }

package/esm/composite/composite-store.js

@@ -2,9 +2,9 @@
 import {
   useCompositeStore,
   useCompositeStoreProps
-} from "../__chunks/A6ER4BO6.js";
-import "../__chunks/HDMIVTNE.js";
-import "../__chunks/4OZYHFMH.js";
+} from "../__chunks/7GBW5FLS.js";
+import "../__chunks/Y6GYTNQ2.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/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/esm/composite/composite-typeahead.js

@@ -2,8 +2,8 @@
 import {
   CompositeTypeahead,
   useCompositeTypeahead
-} from "../__chunks/HBGJOTTX.js";
-import "../__chunks/6QXBPV75.js";
+} from "../__chunks/346FK57L.js";
+import "../__chunks/3IEDWLST.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/3ORBWXWF.js";