@zayne-labs/toolkit-react 0.9.45 → 0.9.47

package/dist/esm/hooks/index.d.ts

@@ -1,199 +1,2 @@
-export { C as ContextError, a as CustomContextOptions, c as createCustomContext, g as getErrorMessage } from '../createCustomContext-BTQFrzrp.js';
-import * as react from 'react';
-import { useEffect, RefCallback } from 'react';
-import { NonEmptyArray, Prettify, AnyFunction, CallbackFn, SelectorFn } from '@zayne-labs/toolkit-type-helpers';
-import * as _zayne_labs_toolkit_core from '@zayne-labs/toolkit-core';
-import { AnimationIntervalOptions, LocationStoreOptions, LocationStoreApi, LocationInfo, ScrollObserverOptions, URLSearchParamsInit, StorageOptions, StorageStoreApi, StoreApi } from '@zayne-labs/toolkit-core';
-
-declare const useAfterMountEffect: typeof useEffect;
-
-declare function useAsyncEffect(effect: () => Promise<ReturnType<React.EffectCallback>>, deps?: React.DependencyList): void;
-
-declare const useEffectOnce: (callBackFn: React.EffectCallback) => void;
-
-type Destructor = ReturnType<React.EffectCallback>;
-type LifeCycleOptions = {
-    onMount?: () => void;
-    onUnmount?: Destructor;
-};
-declare const useLifeCycle: ({ onMount, onUnmount }: LifeCycleOptions) => void;
-
-declare const useMountEffect: (callBackFn: () => void) => void;
-
-declare const useUnmountEffect: (cleanUpFn: Destructor) => void;
-
-type ElementsInfoArray<TTargetElement extends string> = NonEmptyArray<{
-    animationClass: string;
-    targetElement: TTargetElement;
-}>;
-/**
- * This is a custom React hook that adds and removes animation classes to specified HTML elements.
- * @param elementsInfoArray - An array of objects that contain information about the animation class and the target HTML element.
- * @returns - An object containing the refs of the animated elements and a function to handle the initiation and removal animation.
- */
-declare const useAnimateElementRefs: <TTargetElement extends string>(elementsInfoArray: ElementsInfoArray<TTargetElement>) => {
-    animatedElements: Record<TTargetElement, HTMLElement | null>;
-    handleElementsAnimation: () => void;
-};
-
-type AnimationOptions = Prettify<AnimationIntervalOptions & {
-    intervalDuration: number | null;
-    onAnimation: () => void;
-}>;
-declare const useAnimationInterval: (options: AnimationOptions) => {
-    start: () => void;
-    stop: () => void;
-};
-
-/**
- * Returns a stable function that always points to the latest version of the callback function.
- * @param callbackFn - The function to reference
- * @returns a stable function that always points to the latest version of the callback function
- */
-declare const useCallbackRef: <TCallback = AnyFunction>(callbackFn: TCallback | undefined) => TCallback;
-
-type UseClickOutsideOptions = {
-    enabled?: boolean;
-};
-declare const useClickOutside: <TElement extends HTMLElement>(refOrRefArray: Array<React.RefObject<TElement>> | React.RefObject<TElement>, callback: (event: MouseEvent | TouchEvent) => void, options?: UseClickOutsideOptions) => void;
-
-declare const useConstant: <TResult>(initCallbackFn: () => TResult) => TResult;
-
-declare const useCopyToClipboard: () => {
-    copiedValue: string;
-    handleCopy: (value: string) => void;
-};
-
-declare const useDebouncedFn: <TParams>(callBackFn: CallbackFn<TParams>, delay: number | undefined) => {
-    (...params: TParams[]): void;
-    (params: TParams | TParams[], overrideOptions: {
-        $delay: number;
-    }): void;
-    cancel: () => void;
-    cancelMaxWait(): void;
-};
-declare const useDebouncedState: <TValue>(defaultValue: TValue, delay: number | undefined) => readonly [TValue, {
-    (...params: react.SetStateAction<TValue>[]): void;
-    (params: react.SetStateAction<TValue> | react.SetStateAction<TValue>[], overrideOptions: {
-        $delay: number;
-    }): void;
-    cancel: () => void;
-    cancelMaxWait(): void;
-}, react.Dispatch<react.SetStateAction<TValue>>];
-
-type DisclosureOptions = {
-    hasScrollControl?: boolean;
-    initialState?: boolean | (() => boolean);
-};
-declare const useDisclosure: (options?: DisclosureOptions) => {
-    isOpen: boolean;
-    onClose: () => void;
-    onOpen: () => void;
-    onToggle: <TValue>(value?: TValue) => void;
-};
-
-/**
- * @description Returns whether the component is currently being server side rendered or
- * hydrated on the client. Can be used to delay browser-specific rendering
- * until after hydration.
- */
-declare const useIsServer: () => boolean;
-
-type UseLocationResult<TSlice> = [state: TSlice, actions: LocationStoreApi];
-declare const createUseLocationState: (options?: LocationStoreOptions) => Omit<_zayne_labs_toolkit_core.StoreApi<_zayne_labs_toolkit_core.URLInfoObject>, "setState" | "resetState"> & {
-    push: (url: string | _zayne_labs_toolkit_core.PartialURLInfo, options?: {
-        state?: _zayne_labs_toolkit_core.PartialURLInfo["state"];
-    }) => void;
-    replace: LocationStoreApi["push"];
-    triggerPopstateEvent: (nextLocationState?: LocationInfo["state"]) => void;
-} & (<TSlice = _zayne_labs_toolkit_core.URLInfoObject>(selector?: SelectorFn<LocationInfo, TSlice>) => UseLocationResult<TSlice>);
-declare const useLocationState: <TSlice = LocationInfo>(selector?: SelectorFn<LocationInfo, TSlice>, options?: LocationStoreOptions) => UseLocationResult<TSlice>;
-
-type InitialState = boolean | (() => boolean);
-declare const useToggle: (initialValue?: InitialState) => readonly [boolean, <TValue>(newValue?: TValue) => void];
-
-type UsePresenceOptions<TDuration extends number | undefined> = {
-    defaultValue?: boolean;
-    /**
-     * @description The duration of the animation or transition
-     */
-    duration?: TDuration;
-    /**
-     * @description A callback function that will be called when the animation or transition ends
-     */
-    onExitComplete?: () => void;
-};
-type UsePresenceResult<TElement, TDuration> = Prettify<(TDuration extends undefined ? {
-    elementRef: React.RefObject<TElement>;
-} : unknown) & {
-    isPresent: boolean;
-    isVisible: boolean;
-    toggleVisibility: ReturnType<typeof useToggle>[1];
-}>;
-type TypeOption = {
-    /**
-     * @description The type of animation, whether animation or transition
-     * @default "transition"
-     */
-    type?: "animation" | "transition";
-};
-type UsePresence = <TElement extends HTMLElement, TDuration extends number | undefined = undefined>(options?: Prettify<TypeOption & UsePresenceOptions<TDuration>>) => UsePresenceResult<TElement, TDuration>;
-
-/**
- * usePresence hook provides a way to animate an element, before removing it from the DOM.
- * @param defaultValue - The default value for the presence state. Defaults to `true`.
- * @param options - The options for the usePresence hook.
- * @returns A object containing the boolean that should be used to conditionally render the element (isPresent), another boolean used to toggle the animation classes, and a function to toggle the state.
- */
-declare const usePresence: UsePresence;
-
-declare const useScrollObserver: <TElement extends HTMLElement>(options?: ScrollObserverOptions) => {
-    isScrolled: boolean;
-    observedElementRef: RefCallback<TElement>;
-};
-
-declare const useSearch: <TData>(initialData: TData[], delay?: number) => {
-    data: TData[];
-    isLoading: boolean;
-    query: string;
-    setQuery: react.Dispatch<react.SetStateAction<string>>;
-};
-
-type UseSearchParamsOptions = LocationStoreOptions & {
-    action?: "push" | "replace";
-};
-declare const useSearchParams: <TSearchParams extends URLSearchParamsInit>(options?: UseSearchParamsOptions) => readonly [URLSearchParams, {
-    (newQueryParams: TSearchParams | ((prev: URLSearchParams) => TSearchParams)): void;
-    triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core.LocationInfo["state"]) => void;
-}];
-declare const useSearchParamsObject: <TSearchParams extends Record<string, string>>(options?: UseSearchParamsOptions) => readonly [TSearchParams, {
-    (newQueryParams: TSearchParams | ((prev: TSearchParams) => TSearchParams)): void;
-    triggerPopstateEvent: (nextLocationState?: _zayne_labs_toolkit_core.LocationInfo["state"]) => void;
-}];
-
-type UseStorageResult<TState, TSlice = TState> = [state: TSlice, actions: StorageStoreApi<TState>];
-/**
- * @description Creates a custom hook that returns a storage state and actions to modify it. You can use this if you need shared options.
- * @note You must use this if you want to be able to prevent syncing state across tabs.
- */
-declare const createUseStorageState: <TState>(baseOptions: StorageOptions<TState>) => _zayne_labs_toolkit_core.StoreApi<TState> & {
-    removeState: () => void;
-} & (<TSlice = TState>(selector?: SelectorFn<TState, TSlice>) => UseStorageResult<TState, TSlice>);
-type UseStorageStateOptions<TValue> = Omit<StorageOptions<TValue>, "initialValue" | "key">;
-declare const useStorageState: <TValue, TSlice = TValue>(key: string, initialValue?: TValue, options?: UseStorageStateOptions<TValue> & {
-    select?: SelectorFn<TValue, TSlice>;
-}) => UseStorageResult<TValue, TSlice>;
-
-declare const useStore: <TState, TSlice>(store: StoreApi<TState>, selector?: SelectorFn<TState, TSlice>) => TSlice;
-
-declare const useThrottleBySetTimeout: <TParams>(callbackFn: CallbackFn<TParams>, delay: number) => {
-    (...params: TParams[]): void;
-    cancelTimeout(): void;
-};
-declare const useThrottleByTimer: <TParams>(callbackFn: CallbackFn<TParams>, delay: number) => (...params: TParams[]) => void;
-declare const useThrottleByFrame: <TParams>(callbackFn: CallbackFn<TParams>) => {
-    (...params: TParams[]): void;
-    cancelAnimation(): void;
-};
-
-export { createUseLocationState, createUseStorageState, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect };
+import { ContextError$1 as ContextError, CustomContextOptions, createCustomContext$1 as createCustomContext, createUseLocationState$1 as createUseLocationState, createUseStorageState$1 as createUseStorageState, getErrorMessage$1 as getErrorMessage, useAfterMountEffect$1 as useAfterMountEffect, useAnimateElementRefs$1 as useAnimateElementRefs, useAnimationInterval$1 as useAnimationInterval, useAsyncEffect$1 as useAsyncEffect, useCallbackRef$1 as useCallbackRef, useClickOutside$1 as useClickOutside, useConstant$1 as useConstant, useCopyToClipboard$1 as useCopyToClipboard, useDebouncedFn$1 as useDebouncedFn, useDebouncedState$1 as useDebouncedState, useDisclosure$1 as useDisclosure, useEffectOnce$1 as useEffectOnce, useIsServer$1 as useIsServer, useLifeCycle$1 as useLifeCycle, useLocationState$1 as useLocationState, useMountEffect$1 as useMountEffect, usePresence$1 as usePresence, useScrollObserver$1 as useScrollObserver, useSearch$1 as useSearch, useSearchParams$1 as useSearchParams, useSearchParamsObject$1 as useSearchParamsObject, useStorageState$1 as useStorageState, useStore$1 as useStore, useThrottleByFrame$1 as useThrottleByFrame, useThrottleBySetTimeout$1 as useThrottleBySetTimeout, useThrottleByTimer$1 as useThrottleByTimer, useToggle$1 as useToggle, useUnmountEffect$1 as useUnmountEffect } from "../index-DeDvIi3X.js";
+export { ContextError, CustomContextOptions, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect };

package/dist/esm/hooks/index.js

@@ -1,3 +1,3 @@
-export { ContextError, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect } from '../chunk-KFK5FGDY.js';
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map
+import { ContextError, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect } from "../hooks-cJL0eNIo.js";
+
+export { ContextError, createCustomContext, createUseLocationState, createUseStorageState, getErrorMessage, useAfterMountEffect, useAnimateElementRefs, useAnimationInterval, useAsyncEffect, useCallbackRef, useClickOutside, useConstant, useCopyToClipboard, useDebouncedFn, useDebouncedState, useDisclosure, useEffectOnce, useIsServer, useLifeCycle, useLocationState, useMountEffect, usePresence, useScrollObserver, useSearch, useSearchParams, useSearchParamsObject, useStorageState, useStore, useThrottleByFrame, useThrottleBySetTimeout, useThrottleByTimer, useToggle, useUnmountEffect };