@ariakit/react-core 0.4.8 → 0.4.10

package/esm/utils/store.d.ts

@@ -3,6 +3,8 @@ import type { PickByValue, SetState } from "@ariakit/core/utils/types";
 export interface UseState<S> {
     /**
      * Re-renders the component when state changes and returns the current state.
+     * @deprecated Use
+     * [`useStoreState`](https://ariakit.org/reference/use-store-state) instead.
      * @example
      * const state = store.useState();
      */
@@ -12,6 +14,8 @@ export interface UseState<S> {
      * state given the passed key. Changes on other keys will not trigger a
      * re-render.
      * @param key The state key.
+     * @deprecated Use
+     * [`useStoreState`](https://ariakit.org/reference/use-store-state) instead.
      * @example
      * const foo = store.useState("foo");
      */
@@ -22,12 +26,47 @@ export interface UseState<S> {
      * be compared to the previous value. Returns the value returned by the
      * selector function.
      * @param selector The selector function.
+     * @deprecated Use
+     * [`useStoreState`](https://ariakit.org/reference/use-store-state) instead.
      * @example
      * const foo = store.useState((state) => state.foo);
      */
     <V>(selector: (state: S) => V): V;
 }
 type StateKey<T = CoreStore> = keyof StoreState<T>;
+/**
+ * Receives an Ariakit store object (which can be `null` or `undefined`) and
+ * returns the current state. If a key is provided as the second argument, it
+ * returns the value of that key. If a selector function is provided, the state
+ * is passed to it, and its return value is used.
+ *
+ * The component using this hook will re-render when the returned value changes.
+ * @example
+ * Accessing the whole combobox state:
+ * ```js
+ * const combobox = Ariakit.useComboboxStore();
+ * const state = Ariakit.useStoreState(combobox);
+ * ```
+ * @example
+ * Accessing a specific value from the combobox state:
+ * ```js
+ * const combobox = Ariakit.useComboboxStore();
+ * const value = Ariakit.useStoreState(combobox, "value");
+ * ```
+ * @example
+ * Accessing a value using a selector function:
+ * ```js
+ * const combobox = Ariakit.useComboboxStore();
+ * const value = Ariakit.useStoreState(combobox, (state) => state.value);
+ * ```
+ * @example
+ * Accessing the state of a store that may be `null` or `undefined` (for
+ * example, using a context):
+ * ```js
+ * const combobox = Ariakit.useComboboxContext();
+ * const value = Ariakit.useStoreState(combobox, "value");
+ * ```
+ */
 export declare function useStoreState<T extends CoreStore>(store: T): StoreState<T>;
 export declare function useStoreState<T extends CoreStore>(store: T | null | undefined): StoreState<T> | undefined;
 export declare function useStoreState<T extends CoreStore, K extends StateKey<T>>(store: T, key: K): StoreState<T>[K];
@@ -56,6 +95,8 @@ export type Store<T extends CoreStore = CoreStore> = T & {
     /**
      * Re-renders the component when the state changes and returns the current
      * state.
+     * @deprecated Use
+     * [`useStoreState`](https://ariakit.org/reference/use-store-state) instead.
      */
     useState: UseState<StoreState<T>>;
 };

package/esm/utils/store.js

@@ -3,8 +3,8 @@ import {
   useStore,
   useStoreProps,
   useStoreState
-} from "../__chunks/FQ77EHUR.js";
-import "../__chunks/WX6L4ACS.js";
+} from "../__chunks/2GXGCHW6.js";
+import "../__chunks/Z32BISHQ.js";
 import "../__chunks/SK3NAZA3.js";
 import "../__chunks/3YLGPPWQ.js";
 export {

package/esm/utils/system.js

@@ -5,8 +5,8 @@ import {
   createStoreContext,
   forwardRef,
   memo
-} from "../__chunks/PTCNA5XT.js";
-import "../__chunks/WX6L4ACS.js";
+} from "../__chunks/HKOOKEDE.js";
+import "../__chunks/Z32BISHQ.js";
 import "../__chunks/SK3NAZA3.js";
 import "../__chunks/3YLGPPWQ.js";
 export {

package/esm/visually-hidden/visually-hidden.js

@@ -2,9 +2,9 @@
 import {
   VisuallyHidden,
   useVisuallyHidden
-} from "../__chunks/KXBJFI2T.js";
-import "../__chunks/PTCNA5XT.js";
-import "../__chunks/WX6L4ACS.js";
+} from "../__chunks/ILNAUGA4.js";
+import "../__chunks/HKOOKEDE.js";
+import "../__chunks/Z32BISHQ.js";
 import "../__chunks/SK3NAZA3.js";
 import "../__chunks/3YLGPPWQ.js";
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ariakit/react-core",
-  "version": "0.4.8",
+  "version": "0.4.10",
   "description": "Ariakit React core",
   "sideEffects": false,
   "license": "MIT",
@@ -30,7 +30,7 @@
     "core"
   ],
   "dependencies": {
-    "@ariakit/core": "0.4.8",
+    "@ariakit/core": "0.4.9",
     "@floating-ui/dom": "^1.0.0",
     "use-sync-external-store": "^1.2.0"
   },