react-simplikit 0.1.0 → 0.2.0

package/dist/hooks/useList/useList.d.mts

@@ -14,15 +14,18 @@ type UseListReturn<T> = [ReadonlyArray<T>, ListActions<T>];
  * A React hook that manages an array as state.
  * Provides efficient state management and stable action functions.
  *
- * @param {T[]} initialState - Initial array state
- *
- * @returns {UseListReturn<T>} A tuple containing the array state and actions to manipulate it
- * - `push` - Appends a value to the end of the list
- * - `insertAt` - Inserts a value at the specified index
- * - `updateAt` - Updates the value at the specified index
- * - `removeAt` - Removes the value at the specified index
- * - `setAll` - Replaces the entire list with a new array
- * - `reset` - Resets the list to its initial state
+ * @template T - The type of the values held in the list.
+ *
+ * @param {T[]} [initialState=[]] - Initial array state.
+ *
+ * @returns {UseListReturn<T>} A tuple containing the array state and actions to manipulate it.
+ * - list `ReadonlyArray<T>` - The current array state;
+ * - actions.push `(value: T) => void` - Appends a value to the end of the list;
+ * - actions.insertAt `(index: number, value: T) => void` - Inserts a value at the specified index;
+ * - actions.updateAt `(index: number, value: T) => void` - Updates the value at the specified index;
+ * - actions.removeAt `(index: number) => void` - Removes the value at the specified index;
+ * - actions.setAll `(values: T[]) => void` - Replaces the entire list with a new array;
+ * - actions.reset `() => void` - Resets the list to its initial state;
  *
  * @example
  * ```tsx

package/dist/hooks/useList/useList.mjs

@@ -8,15 +8,18 @@ import { useMemo, useState } from "react";
 * A React hook that manages an array as state.
 * Provides efficient state management and stable action functions.
 *
-* @param {T[]} initialState - Initial array state
+* @template T - The type of the values held in the list.
 *
-* @returns {UseListReturn<T>} A tuple containing the array state and actions to manipulate it
-* - `push` - Appends a value to the end of the list
-* - `insertAt` - Inserts a value at the specified index
-* - `updateAt` - Updates the value at the specified index
-* - `removeAt` - Removes the value at the specified index
-* - `setAll` - Replaces the entire list with a new array
-* - `reset` - Resets the list to its initial state
+* @param {T[]} [initialState=[]] - Initial array state.
+*
+* @returns {UseListReturn<T>} A tuple containing the array state and actions to manipulate it.
+* - list `ReadonlyArray<T>` - The current array state;
+* - actions.push `(value: T) => void` - Appends a value to the end of the list;
+* - actions.insertAt `(index: number, value: T) => void` - Inserts a value at the specified index;
+* - actions.updateAt `(index: number, value: T) => void` - Updates the value at the specified index;
+* - actions.removeAt `(index: number) => void` - Removes the value at the specified index;
+* - actions.setAll `(values: T[]) => void` - Replaces the entire list with a new array;
+* - actions.reset `() => void` - Resets the list to its initial state;
 *
 * @example
 * ```tsx

package/dist/hooks/useLongPress/useLongPress.cjs

@@ -3,10 +3,6 @@ const require_usePreservedCallback = require("../usePreservedCallback/usePreserv
 let react = require("react");
 //#region src/hooks/useLongPress/useLongPress.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
 * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/dist/hooks/useLongPress/useLongPress.d.cts

@@ -12,10 +12,6 @@ type UseLongPressOptions<E extends HTMLElement> = {
   onLongPressEnd?: Handler<E>;
 };
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
  * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/dist/hooks/useLongPress/useLongPress.d.mts

@@ -12,10 +12,6 @@ type UseLongPressOptions<E extends HTMLElement> = {
   onLongPressEnd?: Handler<E>;
 };
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
  * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/dist/hooks/useLongPress/useLongPress.mjs

@@ -3,10 +3,6 @@ import { usePreservedCallback } from "../usePreservedCallback/usePreservedCallba
 import { useCallback, useRef } from "react";
 //#region src/hooks/useLongPress/useLongPress.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, window.setTimeout).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useLongPress` is a React hook that detects when an element is pressed and held for a specified duration.
 * It handles both mouse and touch events, making it work consistently across desktop and mobile devices.

package/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.cjs

@@ -3,10 +3,6 @@ const require_usePreservedCallback = require("../usePreservedCallback/usePreserv
 let react = require("react");
 //#region src/hooks/useOutsideClickEffect/useOutsideClickEffect.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
 * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.d.cts

@@ -2,10 +2,6 @@
 //#region src/hooks/useOutsideClickEffect/useOutsideClickEffect.d.ts
 type OneOrMore<T> = T | T[];
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
  * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.d.mts

@@ -2,10 +2,6 @@
 //#region src/hooks/useOutsideClickEffect/useOutsideClickEffect.d.ts
 type OneOrMore<T> = T | T[];
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
  * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.mjs

@@ -3,10 +3,6 @@ import { usePreservedCallback } from "../usePreservedCallback/usePreservedCallba
 import { useEffect, useRef } from "react";
 //#region src/hooks/useOutsideClickEffect/useOutsideClickEffect.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (DOM events, document).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s).
 * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside.

package/dist/hooks/useSet/useSet.cjs

@@ -8,8 +8,17 @@ let react = require("react");
 * A React hook that manages a Set as state.
 * Provides efficient state management and stable action functions.
 *
-* @param {SetOrValues<T>} initialState - Initial Set state (Set object or array of values)
-* @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it
+* @template T - The type of the values held in the set.
+*
+* @param {SetOrValues<T>} [initialState=new Set()] - Initial Set state (Set object or array of values).
+*
+* @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it.
+* - [0] `Omit<Set<T>, 'add' | 'clear' | 'delete'>` - The current Set state with mutation methods hidden;
+* - [1].add `(value: T) => void` - Adds a value to the set;
+* - [1].remove `(value: T) => void` - Removes a value from the set;
+* - [1].toggle `(value: T) => void` - Adds the value if absent, removes it if present;
+* - [1].setAll `(values: Set<T> | T[]) => void` - Replaces all values in the set;
+* - [1].reset `() => void` - Resets the set to its initial state;
 *
 * @example
 * ```tsx

package/dist/hooks/useSet/useSet.d.cts

@@ -14,8 +14,17 @@ type UseSetReturn<T> = [Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>]
  * A React hook that manages a Set as state.
  * Provides efficient state management and stable action functions.
  *
- * @param {SetOrValues<T>} initialState - Initial Set state (Set object or array of values)
- * @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it
+ * @template T - The type of the values held in the set.
+ *
+ * @param {SetOrValues<T>} [initialState=new Set()] - Initial Set state (Set object or array of values).
+ *
+ * @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it.
+ * - [0] `Omit<Set<T>, 'add' | 'clear' | 'delete'>` - The current Set state with mutation methods hidden;
+ * - [1].add `(value: T) => void` - Adds a value to the set;
+ * - [1].remove `(value: T) => void` - Removes a value from the set;
+ * - [1].toggle `(value: T) => void` - Adds the value if absent, removes it if present;
+ * - [1].setAll `(values: Set<T> | T[]) => void` - Replaces all values in the set;
+ * - [1].reset `() => void` - Resets the set to its initial state;
  *
  * @example
  * ```tsx

package/dist/hooks/useSet/useSet.d.mts

@@ -14,8 +14,17 @@ type UseSetReturn<T> = [Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>]
  * A React hook that manages a Set as state.
  * Provides efficient state management and stable action functions.
  *
- * @param {SetOrValues<T>} initialState - Initial Set state (Set object or array of values)
- * @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it
+ * @template T - The type of the values held in the set.
+ *
+ * @param {SetOrValues<T>} [initialState=new Set()] - Initial Set state (Set object or array of values).
+ *
+ * @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it.
+ * - [0] `Omit<Set<T>, 'add' | 'clear' | 'delete'>` - The current Set state with mutation methods hidden;
+ * - [1].add `(value: T) => void` - Adds a value to the set;
+ * - [1].remove `(value: T) => void` - Removes a value from the set;
+ * - [1].toggle `(value: T) => void` - Adds the value if absent, removes it if present;
+ * - [1].setAll `(values: Set<T> | T[]) => void` - Replaces all values in the set;
+ * - [1].reset `() => void` - Resets the set to its initial state;
  *
  * @example
  * ```tsx

package/dist/hooks/useSet/useSet.mjs

@@ -8,8 +8,17 @@ import { useMemo, useState } from "react";
 * A React hook that manages a Set as state.
 * Provides efficient state management and stable action functions.
 *
-* @param {SetOrValues<T>} initialState - Initial Set state (Set object or array of values)
-* @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it
+* @template T - The type of the values held in the set.
+*
+* @param {SetOrValues<T>} [initialState=new Set()] - Initial Set state (Set object or array of values).
+*
+* @returns {UseSetReturn<T>} A tuple containing the Set state and actions to manipulate it.
+* - [0] `Omit<Set<T>, 'add' | 'clear' | 'delete'>` - The current Set state with mutation methods hidden;
+* - [1].add `(value: T) => void` - Adds a value to the set;
+* - [1].remove `(value: T) => void` - Removes a value from the set;
+* - [1].toggle `(value: T) => void` - Adds the value if absent, removes it if present;
+* - [1].setAll `(values: Set<T> | T[]) => void` - Replaces all values in the set;
+* - [1].reset `() => void` - Resets the set to its initial state;
 *
 * @example
 * ```tsx

package/dist/hooks/useStorageState/useStorageState.d.cts

@@ -17,10 +17,6 @@ type StorageStateOptionsWithSerializer<T> = StorageStateOptions<T> & {
 };
 type SerializableGuard<T extends readonly any[]> = T[0] extends any ? T : T[0] extends never ? 'Received a non-serializable value' : T;
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (localStorage/sessionStorage).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useStorageState` is a React that functions like `useState` but persists the state value in browser storage.
  * The value is retained across page reloads and can be shared between tabs when using `localStorage`.

package/dist/hooks/useStorageState/useStorageState.d.mts

@@ -17,10 +17,6 @@ type StorageStateOptionsWithSerializer<T> = StorageStateOptions<T> & {
 };
 type SerializableGuard<T extends readonly any[]> = T[0] extends any ? T : T[0] extends never ? 'Received a non-serializable value' : T;
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (localStorage/sessionStorage).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useStorageState` is a React that functions like `useState` but persists the state value in browser storage.
  * The value is retained across page reloads and can be shared between tabs when using `localStorage`.

package/dist/hooks/useThrottledCallback/useThrottledCallback.cjs

@@ -17,20 +17,27 @@ const NOT_INVOKED = Symbol("NOT_INVOKED");
 * `useThrottledCallback` is a React hook that returns a throttled version of the provided callback function.
 * The throttled callback will only be invoked at most once per specified interval.
 *
+* @template T - The type of the value passed to `onChange`.
 * @param {Object} options - The options object.
-* @param {Function} options.onChange - The callback function to throttle.
+* @param {(newValue: T) => void} options.onChange - The callback to throttle. A call with the same value as the last forwarded one is skipped.
 * @param {number} options.timeThreshold - The number of milliseconds to throttle invocations to.
 * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
 *
-* @returns {Function} A throttled function that limits invoking the callback.
+* @returns {(nextValue: T) => void} A throttled function that forwards the value to `onChange` at most once per interval.
 *
 * @example
-* function ScrollTracker() {
-*   const throttledScroll = useThrottledCallback({
-*     onChange: (scrollY: number) => console.log(scrollY),
-*     timeThreshold: 200,
-*   });
-*   return <div onScroll={(e) => throttledScroll(e.currentTarget.scrollTop)} />;
+* import { useThrottledCallback } from 'react-simplikit';
+* import { useState } from 'react';
+*
+* function ScrollPosition() {
+*   const [scrollTop, setScrollTop] = useState(0);
+*   const setScrollTopThrottled = useThrottledCallback({ onChange: setScrollTop, timeThreshold: 200 });
+*
+*   return (
+*     <div onScroll={e => setScrollTopThrottled(e.currentTarget.scrollTop)}>
+*       <p>Scrolled {scrollTop}px</p>
+*     </div>
+*   );
 * }
 */
 function useThrottledCallback({ onChange, timeThreshold, edges = ["leading", "trailing"] }) {
@@ -47,12 +54,12 @@ function useThrottledCallback({ onChange, timeThreshold, edges = ["leading", "tr
 	}, []);
 	const preservedEdges = require_usePreservedReference.usePreservedReference(edges);
 	return (0, react.useCallback)((nextValue) => {
+		ref.current.clearPreviousThrottle();
 		if (nextValue === ref.current.value) return;
 		const throttled = require_throttle.throttle(() => {
 			handleChange(nextValue);
 			ref.current.value = nextValue;
 		}, timeThreshold, { edges: preservedEdges });
-		ref.current.clearPreviousThrottle();
 		throttled();
 		ref.current.clearPreviousThrottle = throttled.cancel;
 	}, [

package/dist/hooks/useThrottledCallback/useThrottledCallback.d.cts

@@ -8,25 +8,32 @@ type ThrottleOptions = {
  * `useThrottledCallback` is a React hook that returns a throttled version of the provided callback function.
  * The throttled callback will only be invoked at most once per specified interval.
  *
+ * @template T - The type of the value passed to `onChange`.
  * @param {Object} options - The options object.
- * @param {Function} options.onChange - The callback function to throttle.
+ * @param {(newValue: T) => void} options.onChange - The callback to throttle. A call with the same value as the last forwarded one is skipped.
  * @param {number} options.timeThreshold - The number of milliseconds to throttle invocations to.
  * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
  *
- * @returns {Function} A throttled function that limits invoking the callback.
+ * @returns {(nextValue: T) => void} A throttled function that forwards the value to `onChange` at most once per interval.
  *
  * @example
- * function ScrollTracker() {
- *   const throttledScroll = useThrottledCallback({
- *     onChange: (scrollY: number) => console.log(scrollY),
- *     timeThreshold: 200,
- *   });
- *   return <div onScroll={(e) => throttledScroll(e.currentTarget.scrollTop)} />;
+ * import { useThrottledCallback } from 'react-simplikit';
+ * import { useState } from 'react';
+ *
+ * function ScrollPosition() {
+ *   const [scrollTop, setScrollTop] = useState(0);
+ *   const setScrollTopThrottled = useThrottledCallback({ onChange: setScrollTop, timeThreshold: 200 });
+ *
+ *   return (
+ *     <div onScroll={e => setScrollTopThrottled(e.currentTarget.scrollTop)}>
+ *       <p>Scrolled {scrollTop}px</p>
+ *     </div>
+ *   );
  * }
  */
-declare function useThrottledCallback({ onChange, timeThreshold, edges }: ThrottleOptions & {
-  onChange: (newValue: boolean) => void;
+declare function useThrottledCallback<T>({ onChange, timeThreshold, edges }: ThrottleOptions & {
+  onChange: (newValue: T) => void;
   timeThreshold: number;
-}): (nextValue: boolean) => void;
+}): (nextValue: T) => void;
 //#endregion
 export { useThrottledCallback };

package/dist/hooks/useThrottledCallback/useThrottledCallback.d.mts

@@ -8,25 +8,32 @@ type ThrottleOptions = {
  * `useThrottledCallback` is a React hook that returns a throttled version of the provided callback function.
  * The throttled callback will only be invoked at most once per specified interval.
  *
+ * @template T - The type of the value passed to `onChange`.
  * @param {Object} options - The options object.
- * @param {Function} options.onChange - The callback function to throttle.
+ * @param {(newValue: T) => void} options.onChange - The callback to throttle. A call with the same value as the last forwarded one is skipped.
  * @param {number} options.timeThreshold - The number of milliseconds to throttle invocations to.
  * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
  *
- * @returns {Function} A throttled function that limits invoking the callback.
+ * @returns {(nextValue: T) => void} A throttled function that forwards the value to `onChange` at most once per interval.
  *
  * @example
- * function ScrollTracker() {
- *   const throttledScroll = useThrottledCallback({
- *     onChange: (scrollY: number) => console.log(scrollY),
- *     timeThreshold: 200,
- *   });
- *   return <div onScroll={(e) => throttledScroll(e.currentTarget.scrollTop)} />;
+ * import { useThrottledCallback } from 'react-simplikit';
+ * import { useState } from 'react';
+ *
+ * function ScrollPosition() {
+ *   const [scrollTop, setScrollTop] = useState(0);
+ *   const setScrollTopThrottled = useThrottledCallback({ onChange: setScrollTop, timeThreshold: 200 });
+ *
+ *   return (
+ *     <div onScroll={e => setScrollTopThrottled(e.currentTarget.scrollTop)}>
+ *       <p>Scrolled {scrollTop}px</p>
+ *     </div>
+ *   );
  * }
  */
-declare function useThrottledCallback({ onChange, timeThreshold, edges }: ThrottleOptions & {
-  onChange: (newValue: boolean) => void;
+declare function useThrottledCallback<T>({ onChange, timeThreshold, edges }: ThrottleOptions & {
+  onChange: (newValue: T) => void;
   timeThreshold: number;
-}): (nextValue: boolean) => void;
+}): (nextValue: T) => void;
 //#endregion
 export { useThrottledCallback };

package/dist/hooks/useThrottledCallback/useThrottledCallback.mjs

@@ -17,20 +17,27 @@ const NOT_INVOKED = Symbol("NOT_INVOKED");
 * `useThrottledCallback` is a React hook that returns a throttled version of the provided callback function.
 * The throttled callback will only be invoked at most once per specified interval.
 *
+* @template T - The type of the value passed to `onChange`.
 * @param {Object} options - The options object.
-* @param {Function} options.onChange - The callback function to throttle.
+* @param {(newValue: T) => void} options.onChange - The callback to throttle. A call with the same value as the last forwarded one is skipped.
 * @param {number} options.timeThreshold - The number of milliseconds to throttle invocations to.
 * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
 *
-* @returns {Function} A throttled function that limits invoking the callback.
+* @returns {(nextValue: T) => void} A throttled function that forwards the value to `onChange` at most once per interval.
 *
 * @example
-* function ScrollTracker() {
-*   const throttledScroll = useThrottledCallback({
-*     onChange: (scrollY: number) => console.log(scrollY),
-*     timeThreshold: 200,
-*   });
-*   return <div onScroll={(e) => throttledScroll(e.currentTarget.scrollTop)} />;
+* import { useThrottledCallback } from 'react-simplikit';
+* import { useState } from 'react';
+*
+* function ScrollPosition() {
+*   const [scrollTop, setScrollTop] = useState(0);
+*   const setScrollTopThrottled = useThrottledCallback({ onChange: setScrollTop, timeThreshold: 200 });
+*
+*   return (
+*     <div onScroll={e => setScrollTopThrottled(e.currentTarget.scrollTop)}>
+*       <p>Scrolled {scrollTop}px</p>
+*     </div>
+*   );
 * }
 */
 function useThrottledCallback({ onChange, timeThreshold, edges = ["leading", "trailing"] }) {
@@ -47,12 +54,12 @@ function useThrottledCallback({ onChange, timeThreshold, edges = ["leading", "tr
 	}, []);
 	const preservedEdges = usePreservedReference(edges);
 	return useCallback((nextValue) => {
+		ref.current.clearPreviousThrottle();
 		if (nextValue === ref.current.value) return;
 		const throttled = throttle(() => {
 			handleChange(nextValue);
 			ref.current.value = nextValue;
 		}, timeThreshold, { edges: preservedEdges });
-		ref.current.clearPreviousThrottle();
 		throttled();
 		ref.current.clearPreviousThrottle = throttled.cancel;
 	}, [

package/dist/hooks/useVisibilityEvent/useVisibilityEvent.cjs

@@ -2,13 +2,11 @@
 let react = require("react");
 //#region src/hooks/useVisibilityEvent/useVisibilityEvent.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
 *
+* @see `usePageVisibility` returns the visibility as state instead of running a callback.
+*
 * @param {(visibilityState: 'visible' | 'hidden') => void} callback - A function to be called
 * when the visibility state changes. It receives the current visibility state ('visible' or 'hidden') as an argument.
 * @param {object} [options] - Optional configuration for the hook.

package/dist/hooks/useVisibilityEvent/useVisibilityEvent.d.cts

@@ -4,13 +4,11 @@ type Options = {
   immediate?: boolean;
 };
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
  *
+ * @see `usePageVisibility` returns the visibility as state instead of running a callback.
+ *
  * @param {(visibilityState: 'visible' | 'hidden') => void} callback - A function to be called
  * when the visibility state changes. It receives the current visibility state ('visible' or 'hidden') as an argument.
  * @param {object} [options] - Optional configuration for the hook.

package/dist/hooks/useVisibilityEvent/useVisibilityEvent.d.mts

@@ -4,13 +4,11 @@ type Options = {
   immediate?: boolean;
 };
 /**
- * @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
- * react-simplikit is now focused on platform-independent, pure state/logic hooks.
- * This hook will be removed in a future major version.
- *
  * @description
  * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
  *
+ * @see `usePageVisibility` returns the visibility as state instead of running a callback.
+ *
  * @param {(visibilityState: 'visible' | 'hidden') => void} callback - A function to be called
  * when the visibility state changes. It receives the current visibility state ('visible' or 'hidden') as an argument.
  * @param {object} [options] - Optional configuration for the hook.

package/dist/hooks/useVisibilityEvent/useVisibilityEvent.mjs

@@ -2,13 +2,11 @@
 import { useCallback, useEffect } from "react";
 //#region src/hooks/useVisibilityEvent/useVisibilityEvent.ts
 /**
-* @deprecated This hook is deprecated as it depends on browser-specific APIs (document.visibilityState).
-* react-simplikit is now focused on platform-independent, pure state/logic hooks.
-* This hook will be removed in a future major version.
-*
 * @description
 * `useVisibilityEvent` is a React hook that listens to changes in the document's visibility state and triggers a callback.
 *
+* @see `usePageVisibility` returns the visibility as state instead of running a callback.
+*
 * @param {(visibilityState: 'visible' | 'hidden') => void} callback - A function to be called
 * when the visibility state changes. It receives the current visibility state ('visible' or 'hidden') as an argument.
 * @param {object} [options] - Optional configuration for the hook.

package/dist/index.d.cts

@@ -53,7 +53,7 @@ import { useBodyScrollLock } from "./mobile/hooks/useBodyScrollLock/useBodyScrol
 import { useKeyboardHeight } from "./mobile/hooks/useKeyboardHeight/useKeyboardHeight.cjs";
 import { ConnectionType, EffectiveConnectionType, NetworkStatus, useNetworkStatus } from "./mobile/hooks/useNetworkStatus/useNetworkStatus.cjs";
 import { PageVisibility, VisibilityState, usePageVisibility } from "./mobile/hooks/usePageVisibility/usePageVisibility.cjs";
-import { getSafeAreaInset } from "./mobile/utils/getSafeAreaInset/getSafeAreaInset.cjs";
+import { SafeAreaInset, getSafeAreaInset } from "./mobile/utils/getSafeAreaInset/getSafeAreaInset.cjs";
 import { useSafeAreaInset } from "./mobile/hooks/useSafeAreaInset/useSafeAreaInset.cjs";
 import { useScrollDirection } from "./mobile/hooks/useScrollDirection/useScrollDirection.cjs";
 import { useVisualViewport } from "./mobile/hooks/useVisualViewport/useVisualViewport.cjs";
@@ -71,4 +71,4 @@ import { mergeProps } from "./utils/mergeProps/mergeProps.cjs";
 import "./utils/mergeProps/index.cjs";
 import { mergeRefs } from "./utils/mergeRefs/mergeRefs.cjs";
 import "./utils/mergeRefs/index.cjs";
-export { type ConnectionType, type EffectiveConnectionType, ImpressionArea, type NetworkStatus, type PageVisibility, Separated, SwitchCase, type VisibilityState, buildContext, disableBodyScrollLock, enableBodyScrollLock, getKeyboardHeight, getSafeAreaInset, isAndroid, isIOS, isKeyboardVisible, isServer, mergeProps, mergeRefs, subscribeKeyboardHeight, useAsyncEffect, useAvoidKeyboard, useBodyScrollLock, useBooleanState, useCallbackOncePerRender, useConditionalEffect, useControlledState, useCounter, useDebounce, useDebouncedCallback, useDoubleClick, useGeolocation, useImpressionRef, useInputState, useIntersectionObserver, useInterval, useIsClient, useIsomorphicLayoutEffect, useKeyboardHeight, useList, useLoading, useLongPress, useMap, useNetworkStatus, useOutsideClickEffect, usePageVisibility, usePreservedCallback, usePreservedReference, usePrevious, useRefEffect, useSafeAreaInset, useScrollDirection, useSet, useStorageState, useThrottle, useThrottledCallback, useTimeout, useToggle, useVisibilityEvent, useVisualViewport };
+export { type ConnectionType, type EffectiveConnectionType, ImpressionArea, type NetworkStatus, type PageVisibility, type SafeAreaInset, Separated, SwitchCase, type VisibilityState, buildContext, disableBodyScrollLock, enableBodyScrollLock, getKeyboardHeight, getSafeAreaInset, isAndroid, isIOS, isKeyboardVisible, isServer, mergeProps, mergeRefs, subscribeKeyboardHeight, useAsyncEffect, useAvoidKeyboard, useBodyScrollLock, useBooleanState, useCallbackOncePerRender, useConditionalEffect, useControlledState, useCounter, useDebounce, useDebouncedCallback, useDoubleClick, useGeolocation, useImpressionRef, useInputState, useIntersectionObserver, useInterval, useIsClient, useIsomorphicLayoutEffect, useKeyboardHeight, useList, useLoading, useLongPress, useMap, useNetworkStatus, useOutsideClickEffect, usePageVisibility, usePreservedCallback, usePreservedReference, usePrevious, useRefEffect, useSafeAreaInset, useScrollDirection, useSet, useStorageState, useThrottle, useThrottledCallback, useTimeout, useToggle, useVisibilityEvent, useVisualViewport };

package/dist/index.d.mts

@@ -53,7 +53,7 @@ import { useBodyScrollLock } from "./mobile/hooks/useBodyScrollLock/useBodyScrol
 import { useKeyboardHeight } from "./mobile/hooks/useKeyboardHeight/useKeyboardHeight.mjs";
 import { ConnectionType, EffectiveConnectionType, NetworkStatus, useNetworkStatus } from "./mobile/hooks/useNetworkStatus/useNetworkStatus.mjs";
 import { PageVisibility, VisibilityState, usePageVisibility } from "./mobile/hooks/usePageVisibility/usePageVisibility.mjs";
-import { getSafeAreaInset } from "./mobile/utils/getSafeAreaInset/getSafeAreaInset.mjs";
+import { SafeAreaInset, getSafeAreaInset } from "./mobile/utils/getSafeAreaInset/getSafeAreaInset.mjs";
 import { useSafeAreaInset } from "./mobile/hooks/useSafeAreaInset/useSafeAreaInset.mjs";
 import { useScrollDirection } from "./mobile/hooks/useScrollDirection/useScrollDirection.mjs";
 import { useVisualViewport } from "./mobile/hooks/useVisualViewport/useVisualViewport.mjs";
@@ -71,4 +71,4 @@ import { mergeProps } from "./utils/mergeProps/mergeProps.mjs";
 import "./utils/mergeProps/index.mjs";
 import { mergeRefs } from "./utils/mergeRefs/mergeRefs.mjs";
 import "./utils/mergeRefs/index.mjs";
-export { type ConnectionType, type EffectiveConnectionType, ImpressionArea, type NetworkStatus, type PageVisibility, Separated, SwitchCase, type VisibilityState, buildContext, disableBodyScrollLock, enableBodyScrollLock, getKeyboardHeight, getSafeAreaInset, isAndroid, isIOS, isKeyboardVisible, isServer, mergeProps, mergeRefs, subscribeKeyboardHeight, useAsyncEffect, useAvoidKeyboard, useBodyScrollLock, useBooleanState, useCallbackOncePerRender, useConditionalEffect, useControlledState, useCounter, useDebounce, useDebouncedCallback, useDoubleClick, useGeolocation, useImpressionRef, useInputState, useIntersectionObserver, useInterval, useIsClient, useIsomorphicLayoutEffect, useKeyboardHeight, useList, useLoading, useLongPress, useMap, useNetworkStatus, useOutsideClickEffect, usePageVisibility, usePreservedCallback, usePreservedReference, usePrevious, useRefEffect, useSafeAreaInset, useScrollDirection, useSet, useStorageState, useThrottle, useThrottledCallback, useTimeout, useToggle, useVisibilityEvent, useVisualViewport };
+export { type ConnectionType, type EffectiveConnectionType, ImpressionArea, type NetworkStatus, type PageVisibility, type SafeAreaInset, Separated, SwitchCase, type VisibilityState, buildContext, disableBodyScrollLock, enableBodyScrollLock, getKeyboardHeight, getSafeAreaInset, isAndroid, isIOS, isKeyboardVisible, isServer, mergeProps, mergeRefs, subscribeKeyboardHeight, useAsyncEffect, useAvoidKeyboard, useBodyScrollLock, useBooleanState, useCallbackOncePerRender, useConditionalEffect, useControlledState, useCounter, useDebounce, useDebouncedCallback, useDoubleClick, useGeolocation, useImpressionRef, useInputState, useIntersectionObserver, useInterval, useIsClient, useIsomorphicLayoutEffect, useKeyboardHeight, useList, useLoading, useLongPress, useMap, useNetworkStatus, useOutsideClickEffect, usePageVisibility, usePreservedCallback, usePreservedReference, usePrevious, useRefEffect, useSafeAreaInset, useScrollDirection, useSet, useStorageState, useThrottle, useThrottledCallback, useTimeout, useToggle, useVisibilityEvent, useVisualViewport };

package/dist/mobile/hooks/usePageVisibility/usePageVisibility.cjs

@@ -10,6 +10,8 @@ let react = require("react");
 *
 * **SSR Behavior**: Returns `{ isVisible: true, visibilityState: 'visible' }` during server-side rendering.
 *
+* @see `useVisibilityEvent` runs a callback on each change instead of returning state.
+*
 * @returns {PageVisibility} Page visibility information
 * - `isVisible` - True if page is currently visible to the user
 * - `visibilityState` - Current visibility state: 'visible' | 'hidden'

package/dist/mobile/hooks/usePageVisibility/usePageVisibility.d.cts

@@ -22,6 +22,8 @@ type PageVisibility = {
  *
  * **SSR Behavior**: Returns `{ isVisible: true, visibilityState: 'visible' }` during server-side rendering.
  *
+ * @see `useVisibilityEvent` runs a callback on each change instead of returning state.
+ *
  * @returns {PageVisibility} Page visibility information
  * - `isVisible` - True if page is currently visible to the user
  * - `visibilityState` - Current visibility state: 'visible' | 'hidden'

package/dist/mobile/hooks/usePageVisibility/usePageVisibility.d.mts

@@ -22,6 +22,8 @@ type PageVisibility = {
  *
  * **SSR Behavior**: Returns `{ isVisible: true, visibilityState: 'visible' }` during server-side rendering.
  *
+ * @see `useVisibilityEvent` runs a callback on each change instead of returning state.
+ *
  * @returns {PageVisibility} Page visibility information
  * - `isVisible` - True if page is currently visible to the user
  * - `visibilityState` - Current visibility state: 'visible' | 'hidden'

package/dist/mobile/hooks/usePageVisibility/usePageVisibility.mjs

@@ -10,6 +10,8 @@ import { useEffect, useState } from "react";
 *
 * **SSR Behavior**: Returns `{ isVisible: true, visibilityState: 'visible' }` during server-side rendering.
 *
+* @see `useVisibilityEvent` runs a callback on each change instead of returning state.
+*
 * @returns {PageVisibility} Page visibility information
 * - `isVisible` - True if page is currently visible to the user
 * - `visibilityState` - Current visibility state: 'visible' | 'hidden'

package/dist/utils/mergeProps/mergeProps.cjs

@@ -7,7 +7,7 @@
 *
 * @template PropsList - The type of the props objects to merge.
 *
-* @param {PropsList} props - The props objects to merge.
+* @param {...PropsList} props - The props objects to merge.
 * @returns {TupleToIntersection<PropsList>} The merged props object.
 *
 * @example