@siberiacancode/reactuse 0.2.18 → 0.2.19

package/dist/types/hooks/useCssVar/useCssVar.d.ts

@@ -4,12 +4,14 @@ import { StateRef } from '../useRefState/useRefState';
 export interface UseCssVarReturn {
     /** The value of the CSS variable */
     value: string;
+    /** Remove the value of the CSS variable */
+    remove: () => void;
     /** Set the value of the CSS variable */
     set: (value: string) => void;
 }
 export interface UseCssVar {
-    (key: string, initialValue?: string): UseCssVarReturn & {
-        ref: StateRef<Element>;
+    <Target extends HTMLElement>(key: string, initialValue?: string): UseCssVarReturn & {
+        ref: StateRef<Target>;
     };
     (target: HookTarget, key: string, initialValue?: string): UseCssVarReturn;
 }
@@ -24,7 +26,7 @@ export interface UseCssVar {
  * @returns {UseCssVarReturn & { ref: StateRef<Element> }} The object containing the value of the CSS variable and ref
  *
  * @example
- * const { ref, value, set } = useCssVar('--color', 'red');
+ * const { ref, value, set, remove } = useCssVar('--color', 'red');
  *
  * @overload
  * @param {HookTarget} target The target element
@@ -33,6 +35,6 @@ export interface UseCssVar {
  * @returns {UseCssVarReturn} The object containing the value of the CSS variable
  *
  * @example
- * const { value, set } = useCssVar(ref, '--color', 'red');
+ * const { value, set, remove } = useCssVar(ref, '--color', 'red');
  */
 export declare const useCssVar: UseCssVar;

package/dist/types/hooks/useDoubleClick/useDoubleClick.d.ts

@@ -1,14 +1,18 @@
 import { HookTarget } from '../../utils/helpers';
 import { StateRef } from '../useRefState/useRefState';
 export type DoubleClickEvents = MouseEvent | TouchEvent;
+/** The use double click options type */
 export interface UseDoubleClickOptions {
+    /** The threshold time in milliseconds between clicks */
     threshold?: number;
+    /** The callback function to be invoked on single click */
     onSingleClick?: (event: DoubleClickEvents) => void;
 }
 export interface UseDoubleClick {
     (target: HookTarget, callback: (event: DoubleClickEvents) => void, options?: UseDoubleClickOptions): boolean;
     <Target extends Element>(callback: (event: DoubleClickEvents) => void, options?: UseDoubleClickOptions, target?: never): StateRef<Target>;
 }
+export declare const DEFAULT_THRESHOLD_TIME = 300;
 /**
  * @name useDoubleClick
  * @description - Hook that defines the logic when double clicking an element

package/dist/types/hooks/useHash/useHash.d.ts

@@ -5,10 +5,11 @@ type UseHashReturn = [string, (value: string) => void];
  * @description - Hook that manages the hash value
  * @category Browser
  *
+ * @param {string} [initialValue] The initial hash value if no hash exists
  * @returns {UseHashReturn} An array containing the hash value and a function to set the hash value
  *
  * @example
- * const [hash, setHash] = useHash();
+ * const [hash, setHash] = useHash("initial");
  */
-export declare const useHash: () => UseHashReturn;
+export declare const useHash: (initialValue?: string, mode?: "initial" | "replace") => UseHashReturn;
 export {};

package/dist/types/hooks/useShallowEffect/useShallowEffect.d.ts

@@ -0,0 +1,14 @@
+import { DependencyList, EffectCallback } from 'react';
+export declare const deepEqual: (a: any, b: any) => boolean;
+/**
+ * @name useShallowEffect
+ * @description - Hook that executes an effect only when dependencies change shallowly or deeply.
+ * @category Lifecycle
+ *
+ * @param {EffectCallback} effect The effect callback
+ * @param {DependencyList} [deps] The dependencies list for the effect
+ *
+ * @example
+ * useShallowEffect(() => console.log("effect"), [user]);
+ */
+export declare const useShallowEffect: (effect: EffectCallback, deps?: DependencyList) => void;

package/dist/types/hooks/useStorage/useStorage.d.ts

@@ -11,12 +11,8 @@ export interface UseStorageReturn<Value> {
     set: (value: Value) => void;
 }
 export interface UseStorage {
-    <Value>(key: string, options: UseStorageOptions<Value> & {
-        initialValue: UseStorageInitialValue<Value>;
-    }): UseStorageReturn<Value>;
     <Value>(key: string, options?: UseStorageOptions<Value>): UseStorageReturn<Value | undefined>;
-    <Value>(key: string, initialValue: UseStorageInitialValue<Value>): UseStorageReturn<Value>;
-    <Value>(key: string): UseStorageReturn<Value | undefined>;
+    <Value>(key: string, initialValue?: UseStorageInitialValue<Value>): UseStorageReturn<Value | undefined>;
 }
 export declare const STORAGE_EVENT = "reactuse-storage";
 export declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => boolean;

package/dist/types/hooks/useThrottleCallback/useThrottleCallback.d.ts

@@ -1,3 +1,6 @@
+export type ThrottledCallback<Params extends unknown[]> = ((...args: Params) => void) & {
+    cancel: () => void;
+};
 /**
  * @name useThrottleCallback
  * @description - Hook that creates a throttled callback
@@ -12,4 +15,4 @@
  * @example
  * const throttled = useThrottleCallback(() => console.log('callback'), 500);
  */
-export declare const useThrottleCallback: <Params extends unknown[], Return>(callback: (...args: Params) => Return, delay: number) => (...args: Params) => void;
+export declare const useThrottleCallback: <Params extends unknown[], Return>(callback: (...args: Params) => Return, delay: number) => ThrottledCallback<Params>;

package/dist/types/hooks/useWizard/useWizard.d.ts

@@ -12,7 +12,7 @@ export interface WizardItem<WizardStepId> {
  * @returns {UseWizardReturn<WizardStepId>} An object containing the current step id and functions to interact with the wizard
  *
  * @example
- * const { currentStepId, set, reset, back, history } = useWizard([
+ * const { currentStepId, set, reset, back, next, history } = useWizard([
  *  { id: 'step1', nodes: ['step2', 'step3'] },
  *  { id: 'step2', nodes: ['step3'] },
  *  { id: 'step3', nodes: [] },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.2.18",
+  "version": "0.2.19",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",