@ariakit/core 0.3.9 → 0.3.11

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

@@ -10,10 +10,18 @@ export declare function createPopoverStore({ popover: otherPopover, ...props }?:
 export interface PopoverStoreState extends DialogStoreState {
     /**
      * The anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     anchorElement: HTMLElement | null;
     /**
      * The popover element that will render the placement attributes.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Responsive Popover](https://ariakit.org/examples/popover-responsive)
      */
     popoverElement: HTMLElement | null;
     /**
@@ -21,30 +29,42 @@ export interface PopoverStoreState extends DialogStoreState {
      */
     arrowElement: HTMLElement | null;
     /**
-     * The current temporary placement state of the popover. This may be different
-     * from the the `placement` state if the popover has needed to update its
-     * position on the fly.
+     * The current temporary position of the popover. This might differ from the
+     * [`placement`](https://ariakit.org/reference/popover-provider#placement)
+     * state if the popover has had to adjust its position dynamically.
+     *
+     * Live examples:
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     currentPlacement: Placement;
     /**
      * The placement of the popover.
      *
      * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
+     * - [Standalone Popover](https://ariakit.org/examples/popover-standalone)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
      * @default "bottom"
      */
     placement: Placement;
     /**
-     * A symbol that's used to recompute the popover position when the `render`
-     * method is called.
+     * A symbol that's used to recompute the popover position when the
+     * [`render`](https://ariakit.org/reference/use-popover-store#render) method
+     * is called.
      */
     rendered: symbol;
 }
 export interface PopoverStoreFunctions extends DialogStoreFunctions {
     /**
      * Sets the anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     setAnchorElement: SetState<PopoverStoreState["anchorElement"]>;
     /**
@@ -59,6 +79,11 @@ export interface PopoverStoreFunctions extends DialogStoreFunctions {
      * A function that can be used to recompute the popover position. This is
      * useful when the popover anchor changes in a way that affects the popover
      * position.
+     *
+     * Live examples:
+     * - [Textarea with inline
+     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
      */
     render: () => void;
 }

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

@@ -10,10 +10,18 @@ export declare function createPopoverStore({ popover: otherPopover, ...props }?:
 export interface PopoverStoreState extends DialogStoreState {
     /**
      * The anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     anchorElement: HTMLElement | null;
     /**
      * The popover element that will render the placement attributes.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Responsive Popover](https://ariakit.org/examples/popover-responsive)
      */
     popoverElement: HTMLElement | null;
     /**
@@ -21,30 +29,42 @@ export interface PopoverStoreState extends DialogStoreState {
      */
     arrowElement: HTMLElement | null;
     /**
-     * The current temporary placement state of the popover. This may be different
-     * from the the `placement` state if the popover has needed to update its
-     * position on the fly.
+     * The current temporary position of the popover. This might differ from the
+     * [`placement`](https://ariakit.org/reference/popover-provider#placement)
+     * state if the popover has had to adjust its position dynamically.
+     *
+     * Live examples:
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     currentPlacement: Placement;
     /**
      * The placement of the popover.
      *
      * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
+     * - [Standalone Popover](https://ariakit.org/examples/popover-standalone)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
      * @default "bottom"
      */
     placement: Placement;
     /**
-     * A symbol that's used to recompute the popover position when the `render`
-     * method is called.
+     * A symbol that's used to recompute the popover position when the
+     * [`render`](https://ariakit.org/reference/use-popover-store#render) method
+     * is called.
      */
     rendered: symbol;
 }
 export interface PopoverStoreFunctions extends DialogStoreFunctions {
     /**
      * Sets the anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     setAnchorElement: SetState<PopoverStoreState["anchorElement"]>;
     /**
@@ -59,6 +79,11 @@ export interface PopoverStoreFunctions extends DialogStoreFunctions {
      * A function that can be used to recompute the popover position. This is
      * useful when the popover anchor changes in a way that affects the popover
      * position.
+     *
+     * Live examples:
+     * - [Textarea with inline
+     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
      */
     render: () => void;
 }

package/cjs/radio/radio-store.cjs

@@ -1,14 +1,14 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-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');
 require('../__chunks/5F4DVUNS.cjs');
 require('../__chunks/ULSPM3Y3.cjs');
 
@@ -22,18 +22,18 @@ function createRadioStore(_a = {}) {
   var props = _AV6KTKLEcjs.__objRest.call(void 0, _a, []);
   var _a2;
   const syncState = (_a2 = props.store) == null ? void 0 : _a2.getState();
-  const composite = _JNFZSNOIcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
-    focusLoop: _3UT5FE6Kcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true)
+  const composite = _BFE5R4EZcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+    focusLoop: _KBNYGXWIcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true)
   }));
   const initialState = _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, composite.getState()), {
-    value: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    value: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.value,
       syncState == null ? void 0 : syncState.value,
       props.defaultValue,
       null
     )
   });
-  const radio = _2UK5WUJXcjs.createStore.call(void 0, initialState, composite, props.store);
+  const radio = _F6HPKLO2cjs.createStore.call(void 0, initialState, composite, props.store);
   return _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, composite), radio), {
     setValue: (value) => radio.setState("value", value)
   });

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

@@ -18,7 +18,8 @@ export interface RadioStoreState extends CompositeStoreState {
 }
 export interface RadioStoreFunctions extends CompositeStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
+     * state.
      * @example
      * store.setValue("apple");
      * store.setValue((value) => value === "apple" ? "orange" : "apple");

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

@@ -18,7 +18,8 @@ export interface RadioStoreState extends CompositeStoreState {
 }
 export interface RadioStoreFunctions extends CompositeStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
+     * state.
      * @example
      * store.setValue("apple");
      * store.setValue((value) => value === "apple" ? "orange" : "apple");

package/cjs/select/select-store.cjs

@@ -1,13 +1,13 @@
 "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');
 
 
 
@@ -16,10 +16,10 @@ require('../__chunks/UCLKUBNP.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');
 require('../__chunks/5F4DVUNS.cjs');
 
 
@@ -37,9 +37,9 @@ function createSelectStore(_a = {}) {
   } = _b, props = _AV6KTKLEcjs.__objRest.call(void 0, _b, [
     "combobox"
   ]);
-  const store = _2UK5WUJXcjs.mergeStore.call(void 0, 
+  const store = _F6HPKLO2cjs.mergeStore.call(void 0, 
     props.store,
-    _2UK5WUJXcjs.omit.call(void 0, combobox, [
+    _F6HPKLO2cjs.omit.call(void 0, combobox, [
       "value",
       "items",
       "renderedItems",
@@ -51,35 +51,35 @@ function createSelectStore(_a = {}) {
       "disclosureElement"
     ])
   );
-  _2UK5WUJXcjs.throwOnConflictingProps.call(void 0, props, store);
+  _F6HPKLO2cjs.throwOnConflictingProps.call(void 0, props, store);
   const syncState = store.getState();
-  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), {
     store,
-    virtualFocus: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    virtualFocus: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.virtualFocus,
       syncState.virtualFocus,
       true
     ),
-    includesBaseElement: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    includesBaseElement: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.includesBaseElement,
       syncState.includesBaseElement,
       false
     ),
-    activeId: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    activeId: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.activeId,
       syncState.activeId,
       props.defaultActiveId,
       null
     ),
-    orientation: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    orientation: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.orientation,
       syncState.orientation,
       "vertical"
     )
   }));
-  const popover = _EFIT5L4Xcjs.createPopoverStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+  const popover = _E53JW5BDcjs.createPopoverStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
     store,
-    placement: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    placement: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.placement,
       syncState.placement,
       "bottom-start"
@@ -87,24 +87,24 @@ function createSelectStore(_a = {}) {
   }));
   const initialValue = new String("");
   const initialState = _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, composite.getState()), popover.getState()), {
-    value: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    value: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.value,
       syncState.value,
       props.defaultValue,
       initialValue
     ),
-    setValueOnMove: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    setValueOnMove: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.setValueOnMove,
       syncState.setValueOnMove,
       false
     ),
-    selectElement: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState.selectElement, null),
-    labelElement: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState.labelElement, null)
+    selectElement: _KBNYGXWIcjs.defaultValue.call(void 0, syncState.selectElement, null),
+    labelElement: _KBNYGXWIcjs.defaultValue.call(void 0, syncState.labelElement, null)
   });
-  const select = _2UK5WUJXcjs.createStore.call(void 0, initialState, composite, popover, store);
-  _2UK5WUJXcjs.setup.call(void 0, 
+  const select = _F6HPKLO2cjs.createStore.call(void 0, initialState, composite, popover, store);
+  _F6HPKLO2cjs.setup.call(void 0, 
     select,
-    () => _2UK5WUJXcjs.sync.call(void 0, select, ["value", "items"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, select, ["value", "items"], (state) => {
       if (state.value !== initialValue)
         return;
       if (!state.items.length)
@@ -117,9 +117,9 @@ function createSelectStore(_a = {}) {
       select.setState("value", item.value);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     select,
-    () => _2UK5WUJXcjs.sync.call(void 0, select, ["mounted", "items", "value"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, select, ["mounted", "items", "value"], (state) => {
       if (combobox)
         return;
       if (state.mounted)
@@ -136,9 +136,9 @@ function createSelectStore(_a = {}) {
       select.setState("activeId", item.id);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     select,
-    () => _2UK5WUJXcjs.batch.call(void 0, select, ["setValueOnMove", "moves"], (state) => {
+    () => _F6HPKLO2cjs.batch.call(void 0, select, ["setValueOnMove", "moves"], (state) => {
       const { mounted, value, activeId } = select.getState();
       if (!state.setValueOnMove && mounted)
         return;

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

@@ -60,7 +60,8 @@ export interface SelectStoreState<T extends SelectStoreValue = SelectStoreValue>
 }
 export interface SelectStoreFunctions<T extends SelectStoreValue = SelectStoreValue> extends Pick<SelectStoreOptions<T>, "combobox">, CompositeStoreFunctions<SelectStoreItem>, PopoverStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/select-provider#value)
+     * state.
      * @example
      * store.setValue("Apple");
      * store.setValue(["Apple", "Banana"]);

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

@@ -60,7 +60,8 @@ export interface SelectStoreState<T extends SelectStoreValue = SelectStoreValue>
 }
 export interface SelectStoreFunctions<T extends SelectStoreValue = SelectStoreValue> extends Pick<SelectStoreOptions<T>, "combobox">, CompositeStoreFunctions<SelectStoreItem>, PopoverStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/select-provider#value)
+     * state.
      * @example
      * store.setValue("Apple");
      * store.setValue(["Apple", "Banana"]);

package/cjs/tab/tab-store.cjs

@@ -1,19 +1,19 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _JNFZSNOIcjs = require('../__chunks/JNFZSNOI.cjs');
+var _BFE5R4EZcjs = require('../__chunks/BFE5R4EZ.cjs');
 
 
-var _UCLKUBNPcjs = require('../__chunks/UCLKUBNP.cjs');
+var _MI6NUQYQcjs = 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');
 require('../__chunks/5F4DVUNS.cjs');
 require('../__chunks/ULSPM3Y3.cjs');
 
@@ -25,32 +25,32 @@ var _AV6KTKLEcjs = require('../__chunks/AV6KTKLE.cjs');
 function createTabStore(props = {}) {
   var _a;
   const syncState = (_a = props.store) == null ? void 0 : _a.getState();
-  const composite = _JNFZSNOIcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
-    orientation: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const composite = _BFE5R4EZcjs.createCompositeStore.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+    orientation: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.orientation,
       syncState == null ? void 0 : syncState.orientation,
       "horizontal"
     ),
-    focusLoop: _3UT5FE6Kcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true)
+    focusLoop: _KBNYGXWIcjs.defaultValue.call(void 0, props.focusLoop, syncState == null ? void 0 : syncState.focusLoop, true)
   }));
-  const panels = _UCLKUBNPcjs.createCollectionStore.call(void 0, );
+  const panels = _MI6NUQYQcjs.createCollectionStore.call(void 0, );
   const initialState = _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, composite.getState()), {
-    selectedId: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    selectedId: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.selectedId,
       syncState == null ? void 0 : syncState.selectedId,
       props.defaultSelectedId,
       void 0
     ),
-    selectOnMove: _3UT5FE6Kcjs.defaultValue.call(void 0, 
+    selectOnMove: _KBNYGXWIcjs.defaultValue.call(void 0, 
       props.selectOnMove,
       syncState == null ? void 0 : syncState.selectOnMove,
       true
     )
   });
-  const tab = _2UK5WUJXcjs.createStore.call(void 0, initialState, composite, props.store);
-  _2UK5WUJXcjs.setup.call(void 0, 
+  const tab = _F6HPKLO2cjs.createStore.call(void 0, initialState, composite, props.store);
+  _F6HPKLO2cjs.setup.call(void 0, 
     tab,
-    () => _2UK5WUJXcjs.sync.call(void 0, tab, ["moves"], () => {
+    () => _F6HPKLO2cjs.sync.call(void 0, tab, ["moves"], () => {
       const { activeId, selectOnMove } = tab.getState();
       if (!selectOnMove)
         return;
@@ -66,17 +66,17 @@ function createTabStore(props = {}) {
       tab.setState("selectedId", tabItem.id);
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     tab,
-    () => _2UK5WUJXcjs.batch.call(void 0, 
+    () => _F6HPKLO2cjs.batch.call(void 0, 
       tab,
       ["selectedId"],
       (state) => tab.setState("activeId", state.selectedId)
     )
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     tab,
-    () => _2UK5WUJXcjs.sync.call(void 0, tab, ["selectedId", "renderedItems"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, tab, ["selectedId", "renderedItems"], (state) => {
       if (state.selectedId !== void 0)
         return;
       const { activeId, renderedItems } = tab.getState();
@@ -91,13 +91,13 @@ function createTabStore(props = {}) {
       }
     })
   );
-  _2UK5WUJXcjs.setup.call(void 0, 
+  _F6HPKLO2cjs.setup.call(void 0, 
     tab,
-    () => _2UK5WUJXcjs.sync.call(void 0, tab, ["renderedItems"], (state) => {
+    () => _F6HPKLO2cjs.sync.call(void 0, tab, ["renderedItems"], (state) => {
       const tabs = state.renderedItems;
       if (!tabs.length)
         return;
-      return _2UK5WUJXcjs.sync.call(void 0, panels, ["renderedItems"], (state2) => {
+      return _F6HPKLO2cjs.sync.call(void 0, panels, ["renderedItems"], (state2) => {
         const items = state2.renderedItems;
         const hasOrphanPanels = items.some((panel) => !panel.tabId);
         if (!hasOrphanPanels)

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

@@ -10,13 +10,9 @@ export interface TabStorePanel extends CollectionStoreItem {
     tabId?: string | null;
 }
 export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState<TabStoreItem>["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState<TabStoreItem>["focusLoop"];
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
@@ -24,11 +20,13 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     selectedId: TabStoreState["activeId"];
     /**
-     * Whether the tab should be selected when it receives focus. If it's set to
-     * `false`, the tab will be selected only when it's clicked.
+     * Determines if the tab should be selected when it receives focus. If set to
+     * `false`, the tab will only be selected upon clicking, not when
+     * using arrow keys to shift focus.
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
@@ -38,11 +36,11 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
 }
 export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem> {
     /**
-     * Sets the `selectedId` state without moving focus. If you want to move focus,
-     * use the `select` function instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * Sets the
+     * [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid) state
+     * without moving focus. If you want to move focus, use the
+     * [`select`](https://ariakit.org/reference/use-tab-store#select) function
+     * instead.
      * @example
      * // Selects the tab with id "tab-1"
      * store.setSelectedId("tab-1");
@@ -60,9 +58,13 @@ export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem>
     panels: CollectionStore<TabStorePanel>;
     /**
      * Selects the tab for the given id and moves focus to it. If you want to set
-     * the `selectedId` state without moving focus, use the `setSelectedId`
+     * the [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid)
+     * state without moving focus, use the
+     * [`setSelectedId`](https://ariakit.org/reference/use-tab-store#setselectedid-1)
      * function instead.
-     * @param id The id of the tab to select.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      * @example
      * // Selects the tab with id "tab-1"
      * store.select("tab-1");
@@ -77,6 +79,9 @@ export interface TabStoreOptions extends StoreOptions<TabStoreState, "orientatio
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
      * will be automatically set to the first enabled tab.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     defaultSelectedId?: TabStoreState["selectedId"];
 }

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

@@ -10,13 +10,9 @@ export interface TabStorePanel extends CollectionStoreItem {
     tabId?: string | null;
 }
 export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState<TabStoreItem>["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState<TabStoreItem>["focusLoop"];
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
@@ -24,11 +20,13 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     selectedId: TabStoreState["activeId"];
     /**
-     * Whether the tab should be selected when it receives focus. If it's set to
-     * `false`, the tab will be selected only when it's clicked.
+     * Determines if the tab should be selected when it receives focus. If set to
+     * `false`, the tab will only be selected upon clicking, not when
+     * using arrow keys to shift focus.
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
@@ -38,11 +36,11 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
 }
 export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem> {
     /**
-     * Sets the `selectedId` state without moving focus. If you want to move focus,
-     * use the `select` function instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * Sets the
+     * [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid) state
+     * without moving focus. If you want to move focus, use the
+     * [`select`](https://ariakit.org/reference/use-tab-store#select) function
+     * instead.
      * @example
      * // Selects the tab with id "tab-1"
      * store.setSelectedId("tab-1");
@@ -60,9 +58,13 @@ export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem>
     panels: CollectionStore<TabStorePanel>;
     /**
      * Selects the tab for the given id and moves focus to it. If you want to set
-     * the `selectedId` state without moving focus, use the `setSelectedId`
+     * the [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid)
+     * state without moving focus, use the
+     * [`setSelectedId`](https://ariakit.org/reference/use-tab-store#setselectedid-1)
      * function instead.
-     * @param id The id of the tab to select.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      * @example
      * // Selects the tab with id "tab-1"
      * store.select("tab-1");
@@ -77,6 +79,9 @@ export interface TabStoreOptions extends StoreOptions<TabStoreState, "orientatio
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
      * will be automatically set to the first enabled tab.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     defaultSelectedId?: TabStoreState["selectedId"];
 }