@ariakit/core 0.3.9 → 0.3.11

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

@@ -16,16 +16,18 @@ export interface CollectionStoreItem {
 }
 export interface CollectionStoreState<T extends CollectionStoreItem = CollectionStoreItem> {
     /**
-     * Lists all the items with their meta data. This state is automatically
-     * updated when an item is registered or unregistered with the `registerItem`
+     * Lists all items along with their metadata. This state is automatically
+     * updated when an item is registered or unregistered using the
+     * [`registerItem`](https://ariakit.org/reference/use-collection-store#registeritem)
      * function.
      */
     items: T[];
     /**
-     * Lists all the items that are currently rendered. This state is
-     * automatically updated when an item is rendered or unrendered with the
-     * `renderItem` function. This state is also automatically sorted based on
-     * their DOM position.
+     * Lists all items, along with their metadata, in the exact order they appear in
+     * the DOM. This state is automatically updated when an item is rendered or
+     * unmounted using the
+     * [`renderItem`](https://ariakit.org/reference/use-collection-store#renderitem)
+     * function.
      */
     renderedItems: T[];
 }
@@ -33,7 +35,6 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     /**
      * Registers an item in the collection. This function returns a cleanup
      * function that unregisters the item.
-     * @param item The item to register.
      * @example
      * const unregisterItem = store.registerItem({ id: "item-1" });
      * // on cleanup
@@ -42,8 +43,7 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     registerItem: BivariantCallback<(item: T) => () => void>;
     /**
      * Renders an item in the collection. This function returns a cleanup function
-     * that unrenders the item.
-     * @param item The item to render.
+     * that unmounts the item.
      * @example
      * const unrenderItem = store.renderItem({ id: "item-1" });
      * // on cleanup
@@ -52,7 +52,6 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     renderItem: BivariantCallback<(item: T) => () => void>;
     /**
      * Gets an item by its id.
-     * @param id The id of the item.
      * @example
      * const item = store.item("item-1");
      */
@@ -60,7 +59,8 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
 }
 export interface CollectionStoreOptions<T extends CollectionStoreItem = CollectionStoreItem> extends StoreOptions<CollectionStoreState<T>, "items"> {
     /**
-     * The defaut value for the `items` state.
+     * The defaut value for the
+     * [`items`](https://ariakit.org/reference/collection-provider#items) state.
      * @default []
      */
     defaultItems?: CollectionStoreState<T>["items"];

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

@@ -16,16 +16,18 @@ export interface CollectionStoreItem {
 }
 export interface CollectionStoreState<T extends CollectionStoreItem = CollectionStoreItem> {
     /**
-     * Lists all the items with their meta data. This state is automatically
-     * updated when an item is registered or unregistered with the `registerItem`
+     * Lists all items along with their metadata. This state is automatically
+     * updated when an item is registered or unregistered using the
+     * [`registerItem`](https://ariakit.org/reference/use-collection-store#registeritem)
      * function.
      */
     items: T[];
     /**
-     * Lists all the items that are currently rendered. This state is
-     * automatically updated when an item is rendered or unrendered with the
-     * `renderItem` function. This state is also automatically sorted based on
-     * their DOM position.
+     * Lists all items, along with their metadata, in the exact order they appear in
+     * the DOM. This state is automatically updated when an item is rendered or
+     * unmounted using the
+     * [`renderItem`](https://ariakit.org/reference/use-collection-store#renderitem)
+     * function.
      */
     renderedItems: T[];
 }
@@ -33,7 +35,6 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     /**
      * Registers an item in the collection. This function returns a cleanup
      * function that unregisters the item.
-     * @param item The item to register.
      * @example
      * const unregisterItem = store.registerItem({ id: "item-1" });
      * // on cleanup
@@ -42,8 +43,7 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     registerItem: BivariantCallback<(item: T) => () => void>;
     /**
      * Renders an item in the collection. This function returns a cleanup function
-     * that unrenders the item.
-     * @param item The item to render.
+     * that unmounts the item.
      * @example
      * const unrenderItem = store.renderItem({ id: "item-1" });
      * // on cleanup
@@ -52,7 +52,6 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
     renderItem: BivariantCallback<(item: T) => () => void>;
     /**
      * Gets an item by its id.
-     * @param id The id of the item.
      * @example
      * const item = store.item("item-1");
      */
@@ -60,7 +59,8 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
 }
 export interface CollectionStoreOptions<T extends CollectionStoreItem = CollectionStoreItem> extends StoreOptions<CollectionStoreState<T>, "items"> {
     /**
-     * The defaut value for the `items` state.
+     * The defaut value for the
+     * [`items`](https://ariakit.org/reference/collection-provider#items) state.
      * @default []
      */
     defaultItems?: CollectionStoreState<T>["items"];

package/cjs/combobox/combobox-store.cjs

@@ -1,23 +1,23 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _EFIT5L4Xcjs = require('../__chunks/EFIT5L4X.cjs');
-require('../__chunks/2LS4JJ4S.cjs');
-require('../__chunks/GJFZ5ZPP.cjs');
+var _E53JW5BDcjs = require('../__chunks/E53JW5BD.cjs');
+require('../__chunks/I3Y4EXEF.cjs');
+require('../__chunks/OTVLDMN2.cjs');
 
 
-var _JNFZSNOIcjs = require('../__chunks/JNFZSNOI.cjs');
-require('../__chunks/UCLKUBNP.cjs');
+var _BFE5R4EZcjs = require('../__chunks/BFE5R4EZ.cjs');
+require('../__chunks/MI6NUQYQ.cjs');
 
 
 
 
 
 
-var _2UK5WUJXcjs = require('../__chunks/2UK5WUJX.cjs');
+var _F6HPKLO2cjs = require('../__chunks/F6HPKLO2.cjs');
 
 
-var _3UT5FE6Kcjs = require('../__chunks/3UT5FE6K.cjs');
+var _KBNYGXWIcjs = require('../__chunks/KBNYGXWI.cjs');
 
 
 
@@ -33,48 +33,48 @@ var _AV6KTKLEcjs = require('../__chunks/AV6KTKLE.cjs');
 var isSafariOnMobile = _YIUPKKEKcjs.isSafari.call(void 0, ) && _YIUPKKEKcjs.isTouchDevice.call(void 0, );
 function createComboboxStore(props = {}) {
   var _a;
-  _2UK5WUJXcjs.throwOnConflictingProps.call(void 0, props, props.store);
+  _F6HPKLO2cjs.throwOnConflictingProps.call(void 0, props, props.store);
   const syncState = (_a = props.store) == null ? void 0 : _a.getState();
-  const activeId = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const activeId = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.activeId,
     syncState == null ? void 0 : syncState.activeId,
     props.defaultActiveId,
     null
   );
-  const composite = _JNFZSNOIcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+  const composite = _BFE5R4EZcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
     activeId,
-    includesBaseElement: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    includesBaseElement: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.includesBaseElement,
       syncState == null ? void 0 : syncState.includesBaseElement,
       true
     ),
-    orientation: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    orientation: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.orientation,
       syncState == null ? void 0 : syncState.orientation,
       "vertical"
     ),
-    focusLoop: _3UT5FE6Kcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true),
-    focusWrap: _3UT5FE6Kcjs.defaultValue.call(void 0, props.focusWrap, syncState == null ? void 0 : syncState.focusWrap, true),
-    virtualFocus: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    focusLoop: _KBNYGXWIcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true),
+    focusWrap: _KBNYGXWIcjs.defaultValue.call(void 0, props.focusWrap, syncState == null ? void 0 : syncState.focusWrap, true),
+    virtualFocus: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.virtualFocus,
       syncState == null ? void 0 : syncState.virtualFocus,
       !isSafariOnMobile
     )
   }));
-  const popover = _EFIT5L4Xcjs.createPopoverStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
-    placement: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const popover = _E53JW5BDcjs.createPopoverStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+    placement: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.placement,
       syncState == null ? void 0 : syncState.placement,
       "bottom-start"
     )
   }));
-  const value = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const value = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.value,
     syncState == null ? void 0 : syncState.value,
     props.defaultValue,
     ""
   );
-  const selectedValue = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const selectedValue = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.selectedValue,
     syncState == null ? void 0 : syncState.selectedValue,
     props.defaultSelectedValue,
@@ -84,22 +84,22 @@ function createComboboxStore(props = {}) {
   const initialState = _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, composite.getState()), popover.getState()), {
     value,
     selectedValue,
-    resetValueOnSelect: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    resetValueOnSelect: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.resetValueOnSelect,
       syncState == null ? void 0 : syncState.resetValueOnSelect,
       multiSelectable
     ),
-    resetValueOnHide: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    resetValueOnHide: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.resetValueOnHide,
       syncState == null ? void 0 : syncState.resetValueOnHide,
       multiSelectable
     ),
     activeValue: syncState == null ? void 0 : syncState.activeValue
   });
-  const combobox = _2UK5WUJXcjs.createStore.call(void 0, initialState, composite, popover, props.store);
-  _2UK5WUJXcjs.setup.call(void 0, 
+  const combobox = _F6HPKLO2cjs.createStore.call(void 0, initialState, composite, popover, props.store);
+  _F6HPKLO2cjs.setup.call(void 0, 
     combobox,
-    () => _2UK5WUJXcjs.sync.call(void 0, combobox, ["resetValueOnHide", "mounted"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, combobox, ["resetValueOnHide", "mounted"], (state) => {
       if (!state.resetValueOnHide)
         return;
       if (state.mounted)
@@ -107,34 +107,34 @@ function createComboboxStore(props = {}) {
       combobox.setState("value", value);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     combobox,
-    () => _2UK5WUJXcjs.sync.call(void 0, combobox, ["resetValueOnSelect", "selectedValue"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, combobox, ["resetValueOnSelect", "selectedValue"], (state) => {
       if (!state.resetValueOnSelect)
         return;
       combobox.setState("value", value);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     combobox,
-    () => _2UK5WUJXcjs.batch.call(void 0, combobox, ["mounted"], (state) => {
+    () => _F6HPKLO2cjs.batch.call(void 0, combobox, ["mounted"], (state) => {
       if (state.mounted)
         return;
       combobox.setState("activeId", activeId);
       combobox.setState("moves", 0);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     combobox,
-    () => _2UK5WUJXcjs.sync.call(void 0, combobox, ["moves", "activeId"], (state, prevState) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, combobox, ["moves", "activeId"], (state, prevState) => {
       if (state.moves === prevState.moves) {
         combobox.setState("activeValue", void 0);
       }
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     combobox,
-    () => _2UK5WUJXcjs.batch.call(void 0, combobox, ["moves", "renderedItems"], (state, prev) => {
+    () => _F6HPKLO2cjs.batch.call(void 0, combobox, ["moves", "renderedItems"], (state, prev) => {
       if (state.moves === prev.moves)
         return;
       const { activeId: activeId2 } = combobox.getState();

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

@@ -32,7 +32,9 @@ export interface ComboboxStoreState<T extends ComboboxStoreSelectedValue = Combo
      */
     value: string;
     /**
-     * The value of the current active item.
+     * The value of the currently active item. This state automatically updates as
+     * the user navigates the combobox items either by keyboard or mouse click.
+     * Note that it doesn't update when the user simply hovers over the items.
      */
     activeValue: string | undefined;
     /**

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

@@ -32,7 +32,9 @@ export interface ComboboxStoreState<T extends ComboboxStoreSelectedValue = Combo
      */
     value: string;
     /**
-     * The value of the current active item.
+     * The value of the currently active item. This state automatically updates as
+     * the user navigates the combobox items either by keyboard or mouse click.
+     * Note that it doesn't update when the user simply hovers over the items.
      */
     activeValue: string | undefined;
     /**

package/cjs/composite/composite-overflow-store.cjs

@@ -1,16 +1,16 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _EFIT5L4Xcjs = require('../__chunks/EFIT5L4X.cjs');
-require('../__chunks/2LS4JJ4S.cjs');
-require('../__chunks/GJFZ5ZPP.cjs');
-require('../__chunks/2UK5WUJX.cjs');
-require('../__chunks/3UT5FE6K.cjs');
+var _E53JW5BDcjs = require('../__chunks/E53JW5BD.cjs');
+require('../__chunks/I3Y4EXEF.cjs');
+require('../__chunks/OTVLDMN2.cjs');
+require('../__chunks/F6HPKLO2.cjs');
+require('../__chunks/KBNYGXWI.cjs');
 require('../__chunks/AV6KTKLE.cjs');
 
 // src/composite/composite-overflow-store.ts
 function createCompositeOverflowStore(props = {}) {
-  return _EFIT5L4Xcjs.createPopoverStore.call(void 0, props);
+  return _E53JW5BDcjs.createPopoverStore.call(void 0, props);
 }
 
 

package/cjs/composite/composite-store.cjs

@@ -1,13 +1,13 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _JNFZSNOIcjs = require('../__chunks/JNFZSNOI.cjs');
-require('../__chunks/UCLKUBNP.cjs');
-require('../__chunks/2UK5WUJX.cjs');
-require('../__chunks/3UT5FE6K.cjs');
+var _BFE5R4EZcjs = require('../__chunks/BFE5R4EZ.cjs');
+require('../__chunks/MI6NUQYQ.cjs');
+require('../__chunks/F6HPKLO2.cjs');
+require('../__chunks/KBNYGXWI.cjs');
 require('../__chunks/5F4DVUNS.cjs');
 require('../__chunks/ULSPM3Y3.cjs');
 require('../__chunks/AV6KTKLE.cjs');
 
 
-exports.createCompositeStore = _JNFZSNOIcjs.createCompositeStore;
+exports.createCompositeStore = _BFE5R4EZcjs.createCompositeStore;