@ariakit/core - npm Package Compare versions

Comparing version 0.3.10 to 0.3.11

CHANGELOG.md

 # @ariakit/core
 
+## 0.3.11
+
+### Improved performance of large collections
+
+Components like [`MenuItem`](https://ariakit.org/reference/menu-item), [`ComboboxItem`](https://ariakit.org/reference/combobox-item), and [`SelectItem`](https://ariakit.org/reference/select-item) should now offer improved performance when rendering large collections.
+
+### Other updates
+
+- Improved JSDocs.
+
 ## 0.3.10
@@ -4,0 +14,0 @@

cjs/form/form-store.d.ts

@@ -64,3 +64,3 @@ import type { CollectionStoreFunctions, CollectionStoreItem, CollectionStoreOptions, CollectionStoreState } from "../collection/collection-store.js";
     /**
-     * An object containing the names of the form fields for type-safety.
+     * An object containing the names of the form fields for type safety.
      *
@@ -67,0 +67,0 @@ * Live examples:

cjs/hovercard/hovercard-store.d.ts

@@ -15,4 +15,6 @@ import type { PopoverStoreFunctions, PopoverStoreOptions, PopoverStoreState } from "../popover/popover-store.js";
      * The amount of time in milliseconds to wait before showing and hiding the
-     * popover. To control the delay for showing and hiding separately, use
-     * `showTimeout` and `hideTimeout`.
+     * popup. To control the delay for showing and hiding separately, use
+     * [`showTimeout`](https://ariakit.org/reference/hovercard-provider#showtimeout)
+     * and
+     * [`hideTimeout`](https://ariakit.org/reference/hovercard-provider#hidetimeout).
      * @default 500
@@ -22,4 +24,4 @@ */
     /**
-     * The amount of time in milliseconds to wait before **showing** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _showing_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
@@ -34,4 +36,4 @@ *
     /**
-     * The amount of time in milliseconds to wait before **hiding** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _hiding_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
@@ -41,6 +43,8 @@ *
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     hideTimeout?: number;
     /**
-     * Whether the popover or an element inside it should be focused when it is
+     * Whether the popup or an element inside it should be focused when it is
      * shown.
@@ -54,2 +58,5 @@ * @default false
      * Sets the `autoFocusOnShow` state.
+     *
+     * Live examples:
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      */
@@ -56,0 +63,0 @@ setAutoFocusOnShow: SetState<HovercardStoreState["autoFocusOnShow"]>;

cjs/menu/menu-store.d.ts

@@ -16,6 +16,9 @@ import type { ComboboxStore } from "../combobox/combobox-store.js";
     /**
-     * A map of names and values that will be used by the `MenuItemCheckbox` and
-     * `MenuItemRadio` components.
+     * A map of names and values that will be used by the
+     * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox) and
+     * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio)
+     * components.
      *
      * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      * - [Submenu with
@@ -46,3 +49,4 @@ *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
     /**
-     * Sets the `values` state.
+     * Sets the [`values`](https://ariakit.org/reference/menu-provider#values)
+     * state.
      * @example
@@ -73,12 +77,17 @@ * store.setValues({ watching: ["issues"] });
     /**
-     * A reference to a parent menu store. This should be used on nested menus.
+     * A reference to a parent menu store. This is used on nested menus.
      */
     parent?: MenuStore | null;
     /**
-     * A reference to a menu bar store. This should be used when rendering menus
-     * inside a menu bar.
+     * A reference to a menubar store. This is used when rendering menus inside a
+     * menubar.
      */
     menubar?: MenuBarStore | null;
     /**
-     * The default values for the `values` state.
+     * The default values for the
+     * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      * @default {}
@@ -85,0 +94,0 @@ */

cjs/popover/popover-store.d.ts

@@ -13,2 +13,5 @@ import type { DialogStoreFunctions, DialogStoreOptions, DialogStoreState } from "../dialog/dialog-store.js";
      * The anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
@@ -18,2 +21,7 @@ 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)
      */
@@ -26,5 +34,9 @@ popoverElement: 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)
      */
@@ -36,5 +48,9 @@ currentPlacement: Placement;
      * 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"
@@ -44,4 +60,5 @@ */
     /**
-     * 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.
      */
@@ -53,2 +70,5 @@ rendered: symbol;
      * Sets the anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
@@ -68,2 +88,7 @@ setAnchorElement: SetState<PopoverStoreState["anchorElement"]>;
      * position.
+     *
+     * Live examples:
+     * - [Textarea with inline
+     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
      */
@@ -70,0 +95,0 @@ render: () => void;

cjs/radio/radio-store.d.ts

@@ -21,3 +21,4 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreState } from "../composite/composite-store.js";
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
+     * state.
      * @example
@@ -24,0 +25,0 @@ * store.setValue("apple");

cjs/select/select-store.d.ts

@@ -63,3 +63,4 @@ import type { ComboboxStore } from "../combobox/combobox-store.js";
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/select-provider#value)
+     * state.
      * @example
@@ -66,0 +67,0 @@ * store.setValue("Apple");

cjs/tab/tab-store.d.ts

@@ -13,9 +13,5 @@ import type { CollectionStore, CollectionStoreItem } from "../collection/collection-store.js";
 export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState<TabStoreItem>["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState<TabStoreItem>["focusLoop"];
@@ -32,4 +28,5 @@ /**
     /**
-     * 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.
      *
@@ -49,5 +46,2 @@ * Live examples:
      * instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
      * @example
@@ -54,0 +48,0 @@ * // Selects the tab with id "tab-1"

cjs/toolbar/toolbar-store.d.ts

@@ -8,9 +8,5 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreState } from "../composite/composite-store.js";
 export interface ToolbarStoreState extends CompositeStoreState {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState["focusLoop"];
@@ -17,0 +13,0 @@ }

cjs/tooltip/tooltip-store.d.ts

@@ -8,5 +8,11 @@ import type { HovercardStoreFunctions, HovercardStoreOptions, HovercardStoreState } from "../hovercard/hovercard-store.js";
 export interface TooltipStoreState extends HovercardStoreState {
+    /** @default "top" */
+    placement: HovercardStoreState["placement"];
+    /** @default 0 */
+    hideTimeout?: HovercardStoreState["hideTimeout"];
     /**
      * Determines whether the tooltip is being used as a label or a description
      * for the anchor element.
+     * @deprecated Render a visually hidden label or use the `aria-label` or
+     * `aria-labelledby` attributes on the anchor element instead.
      * @default "description"
@@ -21,6 +27,2 @@ */
     skipTimeout: number;
-    /** @default "top" */
-    placement: HovercardStoreState["placement"];
-    /** @default 0 */
-    hideTimeout?: HovercardStoreState["hideTimeout"];
 }
@@ -27,0 +29,0 @@ export type TooltipStoreFunctions = HovercardStoreFunctions;

esm/checkbox/checkbox-store.js

@@ -5,6 +5,6 @@ "use client";
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import {
@@ -11,0 +11,0 @@ __spreadProps,

esm/collection/collection-store.js

 "use client";
 import {
   createCollectionStore
-} from "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -8,0 +8,0 @@ import "../__chunks/4R3V3JGP.js";

esm/combobox/combobox-store.js

 "use client";
 import {
   createPopoverStore
-} from "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
@@ -17,6 +17,6 @@ batch,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import {
@@ -23,0 +23,0 @@ isSafari,

esm/composite/composite-overflow-store.js

 "use client";
 import {
   createPopoverStore
-} from "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -10,0 +10,0 @@

esm/composite/composite-store.js

 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -9,0 +9,0 @@ import "../__chunks/7PRQYBBV.js";

esm/dialog/dialog-store.js

 "use client";
 import {
   createDialogStore
-} from "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -9,0 +9,0 @@ export {

esm/disclosure/disclosure-store.js

 "use client";
 import {
   createDisclosureStore
-} from "../__chunks/L5RYKTVQ.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -8,0 +8,0 @@ export {

esm/form/form-store.d.ts

@@ -64,3 +64,3 @@ import type { CollectionStoreFunctions, CollectionStoreItem, CollectionStoreOptions, CollectionStoreState } from "../collection/collection-store.js";
     /**
-     * An object containing the names of the form fields for type-safety.
+     * An object containing the names of the form fields for type safety.
      *
@@ -67,0 +67,0 @@ * Live examples:

esm/form/form-store.js

 "use client";
 import {
   createCollectionStore
-} from "../__chunks/MYUKSFP5.js";
+} from "../__chunks/22K762VQ.js";
 import {
@@ -10,3 +10,3 @@ createStore,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
@@ -17,3 +17,3 @@ applyState,
   isObject
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -20,0 +20,0 @@ import {

esm/hovercard/hovercard-store.d.ts

@@ -15,4 +15,6 @@ import type { PopoverStoreFunctions, PopoverStoreOptions, PopoverStoreState } from "../popover/popover-store.js";
      * The amount of time in milliseconds to wait before showing and hiding the
-     * popover. To control the delay for showing and hiding separately, use
-     * `showTimeout` and `hideTimeout`.
+     * popup. To control the delay for showing and hiding separately, use
+     * [`showTimeout`](https://ariakit.org/reference/hovercard-provider#showtimeout)
+     * and
+     * [`hideTimeout`](https://ariakit.org/reference/hovercard-provider#hidetimeout).
      * @default 500
@@ -22,4 +24,4 @@ */
     /**
-     * The amount of time in milliseconds to wait before **showing** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _showing_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
@@ -34,4 +36,4 @@ *
     /**
-     * The amount of time in milliseconds to wait before **hiding** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _hiding_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
@@ -41,6 +43,8 @@ *
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     hideTimeout?: number;
     /**
-     * Whether the popover or an element inside it should be focused when it is
+     * Whether the popup or an element inside it should be focused when it is
      * shown.
@@ -54,2 +58,5 @@ * @default false
      * Sets the `autoFocusOnShow` state.
+     *
+     * Live examples:
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      */
@@ -56,0 +63,0 @@ setAutoFocusOnShow: SetState<HovercardStoreState["autoFocusOnShow"]>;

esm/hovercard/hovercard-store.js

 "use client";
 import {
   createHovercardStore
-} from "../__chunks/QJ5CUA32.js";
-import "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/SOLWE6E5.js";
+import "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -11,0 +11,0 @@ export {

esm/menu/menu-bar-store.js

 "use client";
 import {
   createMenubarStore
-} from "../__chunks/UUFF4PQ6.js";
-import "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/XU3EOSCU.js";
+import "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -10,0 +10,0 @@ import "../__chunks/7PRQYBBV.js";

esm/menu/menu-store.d.ts

@@ -16,6 +16,9 @@ import type { ComboboxStore } from "../combobox/combobox-store.js";
     /**
-     * A map of names and values that will be used by the `MenuItemCheckbox` and
-     * `MenuItemRadio` components.
+     * A map of names and values that will be used by the
+     * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox) and
+     * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio)
+     * components.
      *
      * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      * - [Submenu with
@@ -46,3 +49,4 @@ *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
     /**
-     * Sets the `values` state.
+     * Sets the [`values`](https://ariakit.org/reference/menu-provider#values)
+     * state.
      * @example
@@ -73,12 +77,17 @@ * store.setValues({ watching: ["issues"] });
     /**
-     * A reference to a parent menu store. This should be used on nested menus.
+     * A reference to a parent menu store. This is used on nested menus.
      */
     parent?: MenuStore | null;
     /**
-     * A reference to a menu bar store. This should be used when rendering menus
-     * inside a menu bar.
+     * A reference to a menubar store. This is used when rendering menus inside a
+     * menubar.
      */
     menubar?: MenuBarStore | null;
     /**
-     * The default values for the `values` state.
+     * The default values for the
+     * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      * @default {}
@@ -85,0 +94,0 @@ */

esm/menu/menu-store.js

 "use client";
 import {
   createHovercardStore
-} from "../__chunks/QJ5CUA32.js";
-import "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/SOLWE6E5.js";
+import "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
@@ -20,7 +20,7 @@ createStore,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   applyState,
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -27,0 +27,0 @@ import "../__chunks/7PRQYBBV.js";

esm/menubar/menubar-store.js

 "use client";
 import {
   createMenubarStore
-} from "../__chunks/UUFF4PQ6.js";
-import "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/XU3EOSCU.js";
+import "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -10,0 +10,0 @@ import "../__chunks/7PRQYBBV.js";

esm/popover/popover-store.d.ts

@@ -13,2 +13,5 @@ import type { DialogStoreFunctions, DialogStoreOptions, DialogStoreState } from "../dialog/dialog-store.js";
      * The anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
@@ -18,2 +21,7 @@ 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)
      */
@@ -26,5 +34,9 @@ popoverElement: 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)
      */
@@ -36,5 +48,9 @@ currentPlacement: Placement;
      * 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"
@@ -44,4 +60,5 @@ */
     /**
-     * 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.
      */
@@ -53,2 +70,5 @@ rendered: symbol;
      * Sets the anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
@@ -68,2 +88,7 @@ setAnchorElement: SetState<PopoverStoreState["anchorElement"]>;
      * position.
+     *
+     * Live examples:
+     * - [Textarea with inline
+     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
      */
@@ -70,0 +95,0 @@ render: () => void;

esm/popover/popover-store.js

 "use client";
 import {
   createPopoverStore
-} from "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -10,0 +10,0 @@ export {

esm/radio/radio-store.d.ts

@@ -21,3 +21,4 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreState } from "../composite/composite-store.js";
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
+     * state.
      * @example
@@ -24,0 +25,0 @@ * store.setValue("apple");

esm/radio/radio-store.js

 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
   createStore
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -13,0 +13,0 @@ import "../__chunks/7PRQYBBV.js";

esm/select/select-store.d.ts

@@ -63,3 +63,4 @@ import type { ComboboxStore } from "../combobox/combobox-store.js";
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/select-provider#value)
+     * state.
      * @example
@@ -66,0 +67,0 @@ * store.setValue("Apple");

esm/select/select-store.js

 "use client";
 import {
   createPopoverStore
-} from "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
@@ -19,6 +19,6 @@ batch,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -25,0 +25,0 @@ import {

esm/tab/tab-store.d.ts

@@ -13,9 +13,5 @@ import type { CollectionStore, CollectionStoreItem } from "../collection/collection-store.js";
 export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState<TabStoreItem>["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState<TabStoreItem>["focusLoop"];
@@ -32,4 +28,5 @@ /**
     /**
-     * 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.
      *
@@ -49,5 +46,2 @@ * Live examples:
      * instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
      * @example
@@ -54,0 +48,0 @@ * // Selects the tab with id "tab-1"

esm/tab/tab-store.js

 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
+} from "../__chunks/IERTEJ3A.js";
 import {
   createCollectionStore
-} from "../__chunks/MYUKSFP5.js";
+} from "../__chunks/22K762VQ.js";
 import {
@@ -13,6 +13,6 @@ batch,
   sync
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -19,0 +19,0 @@ import "../__chunks/7PRQYBBV.js";

esm/toolbar/toolbar-store.d.ts

@@ -8,9 +8,5 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreState } from "../composite/composite-store.js";
 export interface ToolbarStoreState extends CompositeStoreState {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState["focusLoop"];
@@ -17,0 +13,0 @@ }

esm/toolbar/toolbar-store.js

 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
@@ -11,0 +11,0 @@ import "../__chunks/7PRQYBBV.js";

esm/tooltip/tooltip-store.d.ts

@@ -8,5 +8,11 @@ import type { HovercardStoreFunctions, HovercardStoreOptions, HovercardStoreState } from "../hovercard/hovercard-store.js";
 export interface TooltipStoreState extends HovercardStoreState {
+    /** @default "top" */
+    placement: HovercardStoreState["placement"];
+    /** @default 0 */
+    hideTimeout?: HovercardStoreState["hideTimeout"];
     /**
      * Determines whether the tooltip is being used as a label or a description
      * for the anchor element.
+     * @deprecated Render a visually hidden label or use the `aria-label` or
+     * `aria-labelledby` attributes on the anchor element instead.
      * @default "description"
@@ -21,6 +27,2 @@ */
     skipTimeout: number;
-    /** @default "top" */
-    placement: HovercardStoreState["placement"];
-    /** @default 0 */
-    hideTimeout?: HovercardStoreState["hideTimeout"];
 }
@@ -27,0 +29,0 @@ export type TooltipStoreFunctions = HovercardStoreFunctions;

esm/tooltip/tooltip-store.js

 "use client";
 import {
   createHovercardStore
-} from "../__chunks/QJ5CUA32.js";
-import "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/SOLWE6E5.js";
+import "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createStore
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import {
@@ -15,0 +15,0 @@ __spreadProps,

esm/utils/misc.js

@@ -23,3 +23,3 @@ "use client";
   shallowEqual
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -26,0 +26,0 @@ export {

esm/utils/store.js

@@ -13,4 +13,4 @@ "use client";
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
@@ -17,0 +17,0 @@ export {

package.json

 {
   "name": "@ariakit/core",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "description": "Ariakit core",
@@ -5,0 +5,0 @@ "sideEffects": false,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

490783

increased by1.52%

Lines of code

10044

increased by0.94%

No dependency changes