@reactuses/core 2.2.6 → 2.2.8

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as react from 'react';
 import react__default, { MutableRefObject, useEffect, useLayoutEffect, Dispatch, SetStateAction, DependencyList, EffectCallback, RefObject, CSSProperties } from 'react';
-import lodash from 'lodash';
+import * as lodash from 'lodash';
+import Cookies from 'js-cookie';
 
 declare function usePrevious<T>(state: T): T | undefined;
 
@@ -45,9 +46,9 @@ declare function useSessionStorage(key: string, defaults: boolean, options?: Use
 declare function useSessionStorage<T>(key: string, defaults: T, options?: UseStorageOptions<T>): readonly [T | null, Dispatch<SetStateAction<T | null>>];
 declare function useSessionStorage<T = unknown>(key: string, defaults: null, options?: UseStorageOptions<T>): readonly [T | null, Dispatch<SetStateAction<T | null>>];
 
-declare type Fn = (this: any, ...args: any[]) => any;
-declare type Stoppable = [boolean, Fn, Fn];
-declare type PointerType = "mouse" | "touch" | "pen";
+type Fn = (this: any, ...args: any[]) => any;
+type Stoppable = [boolean, Fn, Fn];
+type PointerType = "mouse" | "touch" | "pen";
 interface Position {
     x: number;
     y: number;
@@ -166,11 +167,11 @@ declare function useTimeout(ms?: number, options?: UseTimeoutFnOptions): Stoppab
 
 declare function useMountedState(): () => boolean;
 
-declare type TargetValue<T> = T | undefined | null;
-declare type TargetType = HTMLElement | Element | Window | Document | EventTarget;
-declare type BasicTarget<T extends TargetType = Element> = (() => TargetValue<T>) | TargetValue<T> | MutableRefObject<TargetValue<T>>;
+type TargetValue<T> = T | undefined | null;
+type TargetType = HTMLElement | Element | Window | Document | EventTarget;
+type BasicTarget<T extends TargetType = Element> = (() => TargetValue<T>) | TargetValue<T> | MutableRefObject<TargetValue<T>>;
 
-declare type Target = BasicTarget<HTMLElement | Element | Window | Document | EventTarget>;
+type Target = BasicTarget<HTMLElement | Element | Window | Document | EventTarget>;
 declare function useEventListener<K extends keyof WindowEventMap>(eventName: K, handler: (event: WindowEventMap[K]) => void, element?: Window, options?: boolean | AddEventListenerOptions): void;
 declare function useEventListener<K extends keyof DocumentEventMap>(eventName: K, handler: (event: DocumentEventMap[K]) => void, element: Document, options?: boolean | AddEventListenerOptions): void;
 declare function useEventListener<K extends keyof HTMLElementEventMap, T extends HTMLElement = HTMLDivElement>(eventName: K, handler: (event: HTMLElementEventMap[K]) => void, element: T, options?: boolean | AddEventListenerOptions): void;
@@ -180,7 +181,7 @@ declare function useEventListener(eventName: string, handler: (...p: any) => voi
 
 declare function useCounter(initialValue?: number | (() => number), max?: number | null, min?: number | null): readonly [number, (newState: number | ((prev: number) => number) | (() => number)) => void, (delta?: number) => void, (delta?: number) => void, () => void];
 
-declare type RafLoopReturns = readonly [() => void, () => void, () => boolean];
+type RafLoopReturns = readonly [() => void, () => void, () => boolean];
 declare function useRafFn(callback: FrameRequestCallback, initiallyActive?: boolean): RafLoopReturns;
 
 interface IListener<T, U = void> {
@@ -218,7 +219,7 @@ declare function useFavicon(href: string, baseUrl?: string, rel?: string): void;
 
 declare function useMutationObserver(callback: MutationCallback, target: BasicTarget, options?: MutationObserverInit): () => void;
 
-declare type DepsEqualFnType<TDeps extends DependencyList> = (prevDeps: TDeps, nextDeps: TDeps) => boolean;
+type DepsEqualFnType<TDeps extends DependencyList> = (prevDeps: TDeps, nextDeps: TDeps) => boolean;
 declare function useCustomCompareEffect<TDeps extends DependencyList>(effect: EffectCallback, deps: TDeps, depsEqual: DepsEqualFnType<TDeps>): void;
 
 declare function useDeepCompareEffect(effect: EffectCallback, deps: DependencyList): void;
@@ -260,12 +261,12 @@ interface UseScriptTagOptions {
      */
     attrs?: Record<string, string>;
 }
-declare type Status = "idle" | "loading" | "ready" | "error";
+type Status = "idle" | "loading" | "ready" | "error";
 declare function useScriptTag(src: string, onLoaded?: (el: HTMLScriptElement) => void, options?: UseScriptTagOptions): readonly [HTMLScriptElement | null, Status, (waitForScriptLoad?: boolean) => Promise<HTMLScriptElement | boolean>, () => void];
 
-declare type IState = PermissionState | "";
-declare type DescriptorNamePolyfill = "accelerometer" | "accessibility-events" | "ambient-light-sensor" | "background-sync" | "camera" | "clipboard-read" | "clipboard-write" | "gyroscope" | "magnetometer" | "microphone" | "notifications" | "payment-handler" | "persistent-storage" | "push" | "speaker";
-declare type GeneralPermissionDescriptor = PermissionDescriptor | {
+type IState = PermissionState | "";
+type DescriptorNamePolyfill = "accelerometer" | "accessibility-events" | "ambient-light-sensor" | "background-sync" | "camera" | "clipboard-read" | "clipboard-write" | "gyroscope" | "magnetometer" | "microphone" | "notifications" | "payment-handler" | "persistent-storage" | "push" | "speaker";
+type GeneralPermissionDescriptor = PermissionDescriptor | {
     name: DescriptorNamePolyfill;
 };
 declare function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor["name"]): IState;
@@ -296,7 +297,7 @@ declare function useMediaDevices(): {
 };
 declare const _default$3: typeof useMediaDevices;
 
-declare type UseTextDirectionValue = "ltr" | "rtl" | "auto";
+type UseTextDirectionValue = "ltr" | "rtl" | "auto";
 interface UseTextDirectionOptions {
     /**
      * CSS Selector for the target element applying to
@@ -539,7 +540,7 @@ interface UseInfiniteScrollOptions extends UseScrollOptions {
 }
 declare function useInfiniteScroll(target: BasicTarget<HTMLElement | SVGElement>, onLoadMore: (state: ReturnType<typeof useScroll>) => void | Promise<void>, options?: UseInfiniteScrollOptions): void;
 
-declare type KeyModifier = "Alt" | "AltGraph" | "CapsLock" | "Control" | "Fn" | "FnLock" | "Meta" | "NumLock" | "ScrollLock" | "Shift" | "Symbol" | "SymbolLock";
+type KeyModifier = "Alt" | "AltGraph" | "CapsLock" | "Control" | "Fn" | "FnLock" | "Meta" | "NumLock" | "ScrollLock" | "Shift" | "Symbol" | "SymbolLock";
 interface UseModifierOptions {
     /**
      * Event names that will prompt update to modifier states
@@ -556,8 +557,8 @@ interface UseModifierOptions {
 }
 declare function useKeyModifier(modifier: KeyModifier, options?: UseModifierOptions): boolean;
 
-declare type IHookStateInitialSetter<S> = () => S;
-declare type IHookStateInitAction<S> = S | IHookStateInitialSetter<S>;
+type IHookStateInitialSetter<S> = () => S;
+type IHookStateInitAction<S> = S | IHookStateInitialSetter<S>;
 
 interface MousePressedOptions {
     /**
@@ -579,7 +580,7 @@ interface MousePressedOptions {
      */
     initialValue?: IHookStateInitAction<boolean>;
 }
-declare type MouseSourceType = "mouse" | "touch" | null;
+type MouseSourceType = "mouse" | "touch" | null;
 declare function useMousePressed(target?: BasicTarget, options?: MousePressedOptions): readonly [boolean, MouseSourceType];
 
 declare function useScrollLock(target: BasicTarget<HTMLElement>, initialState?: boolean): readonly [boolean, (flag: boolean) => void];
@@ -626,10 +627,10 @@ interface UseVirtualListReturn<T> {
 }
 declare function useVirtualList<T = any>(list: T[] | undefined, options: UseVirtualListOptions): UseVirtualListReturn<T>;
 
-declare type ColorScheme = "dark" | "light" | "no-preference";
+type ColorScheme = "dark" | "light" | "no-preference";
 declare function usePreferredColorScheme(defaultState?: ColorScheme): ColorScheme;
 
-declare type Contrast = "more" | "less" | "custom" | "no-preference";
+type Contrast = "more" | "less" | "custom" | "no-preference";
 declare function usePreferredContrast(defaultState?: Contrast): Contrast;
 
 declare function useActiveElement<T extends Element>(): T | null;
@@ -751,7 +752,7 @@ declare function useClipBorad(): readonly [
     (txt: string) => Promise<void>
 ];
 
-declare type EventType = MouseEvent | TouchEvent;
+type EventType = MouseEvent | TouchEvent;
 declare function useClickOutSide(target: BasicTarget, handler: (evt: EventType) => void): void;
 
 declare function useCycleList<T>(list: T[], i?: number): readonly [T, (i?: number) => void, (i?: number) => void];
@@ -814,7 +815,7 @@ declare const useSticky: ({ targetElement, scrollElement, axis, nav, }: UseStick
 declare function useAsyncEffect<T extends void>(effect: () => Promise<T> | T, cleanup?: typeof effect, deps?: DependencyList): void;
 
 declare const getHMSTime: (timeDiff: number) => [string, string, string];
-declare const useCountDown: (time: number, format?: (number: any) => [string, string, string], callback?: () => void) => readonly [string, string, string];
+declare const useCountDown: (time: number, format?: (num: number) => [string, string, string], callback?: () => void) => readonly [string, string, string];
 
 declare function useSupported(callback: () => unknown, sync?: boolean): boolean;
 
@@ -827,6 +828,23 @@ interface EyeDropperOpenReturnType {
     sRGBHex: string;
 }
 declare function useEyeDropper(): readonly [boolean, (options?: EyeDropperOpenOptions) => Promise<EyeDropperOpenReturnType>];
-declare type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>;
+type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>;
 
-export { ColorScheme, Contrast, CursorState, EyeDropperOpenReturnType, GeneralPermissionDescriptor, IDisposable, IEvent, IEventOnce, IListener, INetworkInformation, IState, IUseNetworkState, KeyModifier, MousePressedOptions, MouseSourceType, OrientationState, RafLoopReturns, ScrollIntoViewAnimation, ScrollIntoViewParams, State, Status, Target, UseDarkOptions, UseDraggableOptions, UseElementBoundingOptions, UseEventEmitterReturn, UseEyeDropperReturn, UseFileDialogOptions, UseFpsOptions, UseFullScreenOptions, UseInfiniteScrollOptions, UseLongPressOptions, UseModifierOptions, UseScriptTagOptions, UseScrollOptions, UseStickyParams, UseTextDirectionOptions, UseTextDirectionValue, UseTimeoutFnOptions, UseVirtualListItem, UseVirtualListOptions, UseVirtualListReturn, WindowSize, getHMSTime, useActiveElement, useAsyncEffect, useClickOutSide as useClickOutside, useClipBorad as useClipboard, useControlled, useCountDown, useCounter, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDocumentVisibility, useDraggable, useDropZone, useElementBounding, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEyeDropper, useFavicon, useFileDialog, useFirstMountState, useFocus, _default$2 as useFps, useFullscreen, useGeolocation, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLongPress, _default$3 as useMediaDevices, useMediaQuery, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, _default$1 as useOnceEffect, _default as useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, _default$5 as useUpdateEffect, _default$4 as useUpdateLayoutEffect, useVirtualList, useWindowScroll, useWindowSize, useWindowsFocus };
+type CookieState = string | undefined;
+interface CookieOptions extends Cookies.CookieAttributes {
+    defaultValue?: string | (() => string);
+    /**
+     * set to storage when nodata in effect, fallback to defaultValue
+     */
+    csrData?: CookieState | (() => CookieState);
+}
+declare function useCookie(key: string, options?: CookieOptions): readonly [CookieState, (newValue: CookieState | ((prevState: CookieState) => CookieState)) => void, () => void];
+
+declare function useDoubleClick({ target, latency, onSingleClick, onDoubleClick, }: {
+    target: BasicTarget;
+    latency?: number;
+    onSingleClick?: (e?: MouseEvent | TouchEvent) => void;
+    onDoubleClick?: (e?: MouseEvent | TouchEvent) => void;
+}): void;
+
+export { ColorScheme, Contrast, CookieOptions, CookieState, CursorState, EyeDropperOpenReturnType, GeneralPermissionDescriptor, IDisposable, IEvent, IEventOnce, IListener, INetworkInformation, IState, IUseNetworkState, KeyModifier, MousePressedOptions, MouseSourceType, OrientationState, RafLoopReturns, ScrollIntoViewAnimation, ScrollIntoViewParams, State, Status, Target, UseDarkOptions, UseDraggableOptions, UseElementBoundingOptions, UseEventEmitterReturn, UseEyeDropperReturn, UseFileDialogOptions, UseFpsOptions, UseFullScreenOptions, UseInfiniteScrollOptions, UseLongPressOptions, UseModifierOptions, UseScriptTagOptions, UseScrollOptions, UseStickyParams, UseTextDirectionOptions, UseTextDirectionValue, UseTimeoutFnOptions, UseVirtualListItem, UseVirtualListOptions, UseVirtualListReturn, WindowSize, getHMSTime, useActiveElement, useAsyncEffect, useClickOutSide as useClickOutside, useClipBorad as useClipboard, useControlled, useCookie, useCountDown, useCounter, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEyeDropper, useFavicon, useFileDialog, useFirstMountState, useFocus, _default$2 as useFps, useFullscreen, useGeolocation, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLongPress, _default$3 as useMediaDevices, useMediaQuery, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, _default$1 as useOnceEffect, _default as useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, _default$5 as useUpdateEffect, _default$4 as useUpdateLayoutEffect, useVirtualList, useWindowScroll, useWindowSize, useWindowsFocus };