@siberiacancode/reactuse 0.0.66 → 0.0.68

package/dist/index.d.ts

@@ -795,6 +795,50 @@ interface UseFileDialog {
  */
 declare const useFileDialog: UseFileDialog;
 
+type UseFocusTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+/** The use focus options type */
+interface UseFocusOptions {
+    /** The initial focus state of the target */
+    initialFocus?: boolean;
+}
+/** The use focus return type */
+interface UseFocusReturn {
+    /** Is the target focused */
+    focus: () => void;
+    /** Is the target focused */
+    blur: () => void;
+    /** The boolean state value of the target */
+    focused: boolean;
+}
+interface UseFocus {
+    <Target extends UseFocusTarget>(target: Target, options?: UseFocusOptions): UseFocusReturn;
+    <Target extends UseFocusTarget>(options?: UseFocusOptions): UseFocusReturn & {
+        ref: (node: Target) => void;
+    };
+}
+/**
+ * @name useFocus
+ * @description - Hook that allows you to focus on a specific element
+ * @category Browser
+ *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to focus
+ * @param {boolean} [options.initialFocus=false] The initial focus state of the target
+ * @returns {UseFocusReturn} An object with a `focus` boolean state value
+ *
+ * @example
+ * const { focus, blur, focused } = useFocus(target);
+ *
+ * @overload
+ * @param {boolean} [options.initialFocus=false] The initial focus state of the target
+ * @returns {UseFocusReturn} An object with a `focus` boolean state value
+ *
+ * @example
+ * const { ref, focus, blur, focused } = useFocus();
+ */
+declare const useFocus: UseFocus;
+
 /**
  * @name useFps
  * @description - Hook that measures frames per second
@@ -2177,6 +2221,58 @@ interface UsePaint {
  */
 declare const usePaint: UsePaint;
 
+/** The use parallax value type */
+interface UseParallaxValue {
+    /** Roll value. Scaled to `-0.5 ~ 0.5` */
+    roll: number;
+    /** Tilt value. Scaled to `-0.5 ~ 0.5` */
+    tilt: number;
+    /** Sensor source, can be `mouse` or `deviceOrientation` */
+    source: 'deviceOrientation' | 'mouse';
+}
+/** The use parallax options type */
+interface UseParallaxOptions {
+    /** Device orientation tilt adjust function */
+    deviceOrientationTiltAdjust?: (value: number) => number;
+    /** Device orientation roll adjust function */
+    deviceOrientationRollAdjust?: (value: number) => number;
+    /** Mouse tilt adjust function */
+    mouseTiltAdjust?: (value: number) => number;
+    /** Mouse roll adjust function */
+    mouseRollAdjust?: (value: number) => number;
+}
+interface UseParallaxReturn {
+    value: UseParallaxValue;
+}
+interface UseParallax {
+    <Target extends UseMouseTarget>(target: Target, options?: UseParallaxOptions): UseParallaxReturn;
+    <Target extends UseMouseTarget>(params?: UseParallaxOptions): UseParallaxReturn & {
+        ref: (node: Target) => void;
+    };
+}
+/**
+ * @name useParallax
+ * @description - Hook to help create parallax effect
+ * @category Sensors
+ *
+ * @overload
+ * @template Target The target element for the parallax effect
+ * @param {Target} target The target element for the parallax effect
+ * @param {UseParallaxOptions} options The options for the parallax effect
+ * @returns {UseParallaxReturn} An object with the current mouse position
+ *
+ * @example
+ * const { roll, tilt, source } = useParallax(target);
+ *
+ * @overload
+ * @template Target The target element for the parallax effect
+ * @param {UseParallaxOptions} options The options for the parallax effect
+ *
+ * @example
+ * const { ref, roll, tilt, source } = useParallax();
+ */
+declare const useParallax: UseParallax;
+
 /** The permission name */
 type UsePermissionName = PermissionName | 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker';
 /** The use permission return type */
@@ -2789,6 +2885,55 @@ interface UseTimeoutReturn {
  */
 declare function useTimeout(callback: () => void, delay: number): UseTimeoutReturn;
 
+declare const getTimeFromSeconds: (timestamp: number) => {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+};
+/** The use timer options type */
+interface UseTimerOptions {
+    /** Whether the timer should start automatically */
+    autostart?: boolean;
+    /** Callback function to be executed on each tick of the timer */
+    onTick?: (seconds: number) => void;
+}
+/** The use timer return type */
+interface UseTimerReturn {
+    /** flag to indicate if timer is running or not */
+    running: boolean;
+    /** The day count of the timer */
+    days: number;
+    /** The hour count of the timer */
+    hours: number;
+    /** The minute count of the timer */
+    minutes: number;
+    /** The second count of the timer */
+    seconds: number;
+    /** The function to pause the timer */
+    pause: () => void;
+    /** The function to start the timer */
+    start: () => void;
+    /** The function to restart the timer */
+    restart: (time: number, autostart?: boolean) => void;
+    /** The function to toggle the timer */
+    toggle: () => void;
+}
+/**
+ * @name useTimer
+ * @description - Hook that creates a timer functionality
+ * @category Time
+ *
+ * @param {number} timestamp The timestamp value that define for how long the timer will be running
+ * @param {() => void} callback The function to be executed once countdown timer is expired
+ * @param {boolean} options.autostart The flag to decide if timer should start automatically
+ * @param {(timestamp: number) => void} options.onTick The function to be executed on each tick of the timer
+ *
+ * @example
+ * const { days, hours, minutes, seconds, toggle, pause, start, restart, running } = useTimer(1000, () => console.log('ready'));
+ */
+declare const useTimer: (timestamp: number, callback: () => void, options?: UseTimerOptions) => UseTimerReturn;
+
 /** The use toggle return type */
 type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
 /**
@@ -2949,7 +3094,7 @@ declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardSte
     history: WizardStepId[];
 };
 
-declare const debounce: <Params extends unknown[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
+declare function debounce<Params extends unknown[]>(callback: (...args: Params) => void, delay: number): ((...args: Params) => void);
 
 type GetElementTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
 declare const getElement: <Target extends GetElementTarget>(target: Target) => Element | (Target & Document) | (Target & Window) | null | undefined;
@@ -2974,4 +3119,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type UseAsyncReturn, type UseBatteryStateReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UsePermissionName, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };
+export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type UseAsyncReturn, type UseBatteryStateReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFocus, type UseFocusOptions, type UseFocusReturn, type UseFocusTarget, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UseParallax, type UseParallaxOptions, type UseParallaxValue, type UsePermissionName, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFocus, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useTimer, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@siberiacancode/reactuse",
   "type": "module",
-  "version": "0.0.66",
+  "version": "0.0.68",
   "description": "Ultimate tool",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",
@@ -44,7 +44,8 @@
     "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
     "lint": "eslint . --fix",
     "type": "tsc --noEmit",
-    "pretty": "yarn type && yarn lint",
+    "format": "prettier --write .",
+    "pretty": "yarn type && yarn lint && yarn format",
     "prepare": "husky",
     "unit-test": "vitest",
     "docs:dev": "vitepress dev docs",
@@ -67,6 +68,7 @@
   "devDependencies": {
     "@siberiacancode/builder": "^1.3.0",
     "@siberiacancode/eslint": "^2.1.0",
+    "@siberiacancode/prettier": "^1.1.1",
     "@siberiacancode/vitest": "^1.2.4",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.0.0",
@@ -89,10 +91,12 @@
   },
   "lint-staged": {
     "*.js": [
-      "eslint --fix"
+      "eslint --fix",
+      "prettier --write"
     ],
     "*.ts": [
-      "eslint --fix"
+      "eslint --fix",
+      "prettier --write"
     ]
   }
 }

package/dist/cjs/_rollupPluginBabelHelpers-DA8CS73W.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-DA8CS73W.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-CWXiPzDd.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-CWXiPzDd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}