@ariakit/core 0.3.10 → 0.4.0

package/esm/hovercard/hovercard-store.js

@@ -1,12 +1,12 @@
 "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/BRS7GKWU.js";
+import "../__chunks/MFZZDIHG.js";
+import "../__chunks/5RJNXXU2.js";
+import "../__chunks/WCKXDMU7.js";
+import "../__chunks/R676XYVY.js";
+import "../__chunks/22HHDS5F.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   createHovercardStore

package/esm/menu/menu-bar-store.js

@@ -1,12 +1,12 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/UUFF4PQ6.js";
-import "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/PXYVPXSS.js";
+import "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
+import "../__chunks/R676XYVY.js";
+import "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import "../__chunks/4R3V3JGP.js";
 

package/esm/menu/menu-store.d.ts

@@ -13,10 +13,13 @@ export interface MenuStoreState<T extends MenuStoreValues = MenuStoreValues> ext
      */
     initialFocus: "container" | "first" | "last";
     /**
-     * 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
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
@@ -42,7 +45,8 @@ export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues>
      */
     setInitialFocus: SetState<MenuStoreState<T>["initialFocus"]>;
     /**
-     * Sets the `values` state.
+     * Sets the [`values`](https://ariakit.org/reference/menu-provider#values)
+     * state.
      * @example
      * store.setValues({ watching: ["issues"] });
      * store.setValues((values) => ({ ...values, watching: ["issues"] }));
@@ -68,16 +72,21 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      */
     combobox?: ComboboxStore | null;
     /**
-     * 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 {}
      */
     defaultValues?: MenuStoreState<T>["values"];

package/esm/menu/menu-store.js

@@ -1,14 +1,14 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/QJ5CUA32.js";
-import "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/BRS7GKWU.js";
+import "../__chunks/MFZZDIHG.js";
+import "../__chunks/5RJNXXU2.js";
+import "../__chunks/WCKXDMU7.js";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
 import {
   createStore,
   mergeStore,
@@ -17,12 +17,12 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/R676XYVY.js";
 import {
   applyState,
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import {
   __objRest,

package/esm/menubar/menubar-store.js

@@ -1,12 +1,12 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/UUFF4PQ6.js";
-import "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/PXYVPXSS.js";
+import "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
+import "../__chunks/R676XYVY.js";
+import "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import "../__chunks/4R3V3JGP.js";
 export {

package/esm/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/esm/popover/popover-store.js

@@ -1,11 +1,11 @@
 "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/MFZZDIHG.js";
+import "../__chunks/5RJNXXU2.js";
+import "../__chunks/WCKXDMU7.js";
+import "../__chunks/R676XYVY.js";
+import "../__chunks/22HHDS5F.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   createPopoverStore

package/esm/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/esm/radio/radio-store.js

@@ -1,15 +1,15 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
 import {
   createStore
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/R676XYVY.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import {
   __objRest,

package/esm/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/esm/select/select-store.js

@@ -1,13 +1,13 @@
 "use client";
 import {
   createPopoverStore
-} from "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/MFZZDIHG.js";
+import "../__chunks/5RJNXXU2.js";
+import "../__chunks/WCKXDMU7.js";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
+} from "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
 import {
   batch,
   createStore,
@@ -16,11 +16,11 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/R676XYVY.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import {
   toArray
 } from "../__chunks/7PRQYBBV.js";

package/esm/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
@@ -28,8 +24,9 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
      */
     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)
@@ -44,9 +41,6 @@ export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem>
      * without moving focus. If you want to move focus, use the
      * [`select`](https://ariakit.org/reference/use-tab-store#select) function
      * instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
      * @example
      * // Selects the tab with id "tab-1"
      * store.setSelectedId("tab-1");

package/esm/tab/tab-store.js

@@ -1,20 +1,20 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
+} from "../__chunks/2H5K47H4.js";
 import {
   createCollectionStore
-} from "../__chunks/MYUKSFP5.js";
+} from "../__chunks/URUD7X4C.js";
 import {
   batch,
   createStore,
   setup,
   sync
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/R676XYVY.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import {
   __spreadProps,

package/esm/toolbar/toolbar-store.d.ts

@@ -5,13 +5,9 @@ import type { Store, StoreOptions, StoreProps } from "../utils/store.js";
  */
 export declare function createToolbarStore(props?: ToolbarStoreProps): ToolbarStore;
 export interface ToolbarStoreState extends CompositeStoreState {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState["focusLoop"];
 }
 export interface ToolbarStoreFunctions extends CompositeStoreFunctions {

package/esm/toolbar/toolbar-store.js

@@ -1,13 +1,13 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/VEUNYQYR.js";
-import "../__chunks/MYUKSFP5.js";
-import "../__chunks/K6ELJFXN.js";
+} from "../__chunks/2H5K47H4.js";
+import "../__chunks/URUD7X4C.js";
+import "../__chunks/R676XYVY.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/22HHDS5F.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/7PRQYBBV.js";
 import {
   __spreadProps,

package/esm/tooltip/tooltip-store.d.ts

@@ -5,9 +5,15 @@ import type { Store, StoreOptions, StoreProps } from "../utils/store.js";
  */
 export declare function createTooltipStore(props?: TooltipStoreProps): TooltipStore;
 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"
      */
     type: "label" | "description";
@@ -17,10 +23,6 @@ export interface TooltipStoreState extends HovercardStoreState {
      * @default 300
      */
     skipTimeout: number;
-    /** @default "top" */
-    placement: HovercardStoreState["placement"];
-    /** @default 0 */
-    hideTimeout?: HovercardStoreState["hideTimeout"];
 }
 export type TooltipStoreFunctions = HovercardStoreFunctions;
 export interface TooltipStoreOptions extends HovercardStoreOptions, StoreOptions<TooltipStoreState, "type" | "placement" | "timeout" | "showTimeout" | "hideTimeout" | "skipTimeout"> {

package/esm/tooltip/tooltip-store.js

@@ -1,16 +1,16 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/QJ5CUA32.js";
-import "../__chunks/AKMSZ36N.js";
-import "../__chunks/25MEC56I.js";
-import "../__chunks/L5RYKTVQ.js";
+} from "../__chunks/BRS7GKWU.js";
+import "../__chunks/MFZZDIHG.js";
+import "../__chunks/5RJNXXU2.js";
+import "../__chunks/WCKXDMU7.js";
 import {
   createStore
-} from "../__chunks/K6ELJFXN.js";
+} from "../__chunks/R676XYVY.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/22HHDS5F.js";
 import {
   __spreadProps,
   __spreadValues
@@ -19,6 +19,15 @@ import {
 // src/tooltip/tooltip-store.ts
 function createTooltipStore(props = {}) {
   var _a;
+  if (process.env.NODE_ENV !== "production") {
+    if (props.type === "label") {
+      console.warn(
+        "The `type` option on the tooltip store is deprecated.",
+        "Render a visually hidden label or use the `aria-label` or `aria-labelledby` attributes on the anchor element instead.",
+        "See https://ariakit.org/components/tooltip#tooltip-anchors-must-have-accessible-names"
+      );
+    }
+  }
   const syncState = (_a = props.store) == null ? void 0 : _a.getState();
   const hovercard = createHovercardStore(__spreadProps(__spreadValues({}, props), {
     placement: defaultValue(

package/esm/utils/dom.js

@@ -18,7 +18,7 @@ import {
   matches,
   scrollIntoViewIfNeeded,
   setSelectionRange
-} from "../__chunks/DLOEKDPY.js";
+} from "../__chunks/RRSZHCH6.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   canUseDOM,

package/esm/utils/events.js

@@ -1,10 +1,10 @@
 "use client";
 import {
   isApple
-} from "../__chunks/MHPO2BXA.js";
+} from "../__chunks/VDNATJW2.js";
 import {
   contains
-} from "../__chunks/DLOEKDPY.js";
+} from "../__chunks/RRSZHCH6.js";
 import {
   __spreadProps,
   __spreadValues

package/esm/utils/focus.js

@@ -6,7 +6,7 @@ import {
   isFrame,
   isVisible,
   matches
-} from "../__chunks/DLOEKDPY.js";
+} from "../__chunks/RRSZHCH6.js";
 import {
   __spreadValues
 } from "../__chunks/4R3V3JGP.js";

package/esm/utils/misc.d.ts

@@ -113,6 +113,10 @@ export declare function disabledFromProps(props: {
     disabled?: boolean;
     "aria-disabled"?: boolean | "true" | "false";
 }): boolean;
+/**
+ * Removes undefined values from an object.
+ */
+export declare function removeUndefinedValues<T extends AnyObject>(obj: T): T;
 /**
  * Returns the first value that is not `undefined`.
  */

package/esm/utils/misc.js

@@ -19,8 +19,9 @@ import {
   normalizeString,
   omit,
   pick,
+  removeUndefinedValues,
   shallowEqual
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/22HHDS5F.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   afterPaint,
@@ -42,5 +43,6 @@ export {
   normalizeString,
   omit,
   pick,
+  removeUndefinedValues,
   shallowEqual
 };

package/esm/utils/platform.js

@@ -5,8 +5,8 @@ import {
   isMac,
   isSafari,
   isTouchDevice
-} from "../__chunks/MHPO2BXA.js";
-import "../__chunks/DLOEKDPY.js";
+} from "../__chunks/VDNATJW2.js";
+import "../__chunks/RRSZHCH6.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   isApple,

package/esm/utils/store.js

@@ -10,8 +10,8 @@ import {
   subscribe,
   sync,
   throwOnConflictingProps
-} from "../__chunks/K6ELJFXN.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/R676XYVY.js";
+import "../__chunks/22HHDS5F.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   batch,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ariakit/core",
-  "version": "0.3.10",
+  "version": "0.4.0",
   "description": "Ariakit core",
   "sideEffects": false,
   "license": "MIT",