@siberiacancode/reactuse 0.0.65 → 0.0.67

package/dist/esm/utils/helpers/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.65 */
+/* @license @siberiacancode/reactuse v0.0.67 */
 export{debounce}from"./debounce.js";export{getElement}from"./getElement.js";export{getRetry}from"./getRetry.js";export{isClient}from"./isClient.js";export{throttle}from"./throttle.js";export{getDate}from"./time/getDate.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/utils/helpers/isClient.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.65 */
+/* @license @siberiacancode/reactuse v0.0.67 */
 var n,d,e=!("undefined"==typeof window||null===(n=window)||void 0===n||!n.document||null===(d=window)||void 0===d||null===(d=d.document)||void 0===d||!d.createElement);export{e as isClient};
 //# sourceMappingURL=isClient.js.map

package/dist/esm/utils/helpers/throttle.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.65 */
+/* @license @siberiacancode/reactuse v0.0.67 */
 var n=function(n,t){var o=!1;return function(){o||(n.apply(void 0,arguments),o=!0,setTimeout((function(){o=!1}),t))}};export{n as throttle};
 //# sourceMappingURL=throttle.js.map

package/dist/esm/utils/helpers/time/getDate.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.65 */
+/* @license @siberiacancode/reactuse v0.0.67 */
 var e=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:new Date,t=e.getSeconds(),n=e.getMinutes(),r=e.getHours();return{seconds:t,minutes:n,hours:r,meridiemHours:{value:r%12==0?12:r%12,type:r>=12?"pm":"am"},day:e.getDate(),month:e.getMonth()+1,year:e.getFullYear(),timestamp:e.getTime()}};export{e as getDate};
 //# sourceMappingURL=getDate.js.map

package/dist/index.d.ts

@@ -419,8 +419,11 @@ interface UseDeviceMotionReturn {
     rotationRate: DeviceMotionEventRotationRate;
 }
 interface UseDeviceMotionParams {
+    /** The delay in milliseconds */
     delay?: number;
+    /** The callback function to be invoked */
     callback?: (event: DeviceMotionEvent) => void;
+    /** Whether to enable the hook */
     enabled?: boolean;
 }
 /**
@@ -438,6 +441,34 @@ interface UseDeviceMotionParams {
  */
 declare const useDeviceMotion: (params?: UseDeviceMotionParams) => UseDeviceMotionReturn;
 
+interface UseDeviceOrientationValue {
+    /** A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 to 360 */
+    alpha: number | null;
+    /** A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 to 180 */
+    beta: number | null;
+    /** A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 to 90 */
+    gamma: number | null;
+    /** The current absolute value */
+    absolute: boolean;
+}
+interface UseDeviceOrientationReturn {
+    /** Whether the device orientation is supported */
+    supported: boolean;
+    /** The current device orientation value */
+    value: UseDeviceOrientationValue;
+}
+/**
+ * @name useDeviceOrientation
+ * @description - Hook that provides the current device orientation
+ * @category Sensors
+ *
+ * @returns {UseDeviceOrientationReturn} The current device orientation
+ *
+ * @example
+ * const { supported, value } = useDeviceOrientation();
+ */
+declare const useDeviceOrientation: () => UseDeviceOrientationReturn;
+
 /**
  * @name useDidUpdate
  * @description – Hook that behaves like useEffect, but skips the effect on the initial render
@@ -1665,6 +1696,8 @@ interface UseMouseReturn {
     x: number;
     /** The current mouse y position */
     y: number;
+    /** The current element */
+    element: Element;
     /** The current element x position */
     elementX: number;
     /** The current element y position */
@@ -2144,6 +2177,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 */
@@ -2427,6 +2512,40 @@ interface UseResizeObserver {
  */
 declare const useResizeObserver: UseResizeObserver;
 
+declare global {
+    interface ScreenOrientation {
+        lock: (orientation: OrientationLockType) => Promise<void>;
+    }
+}
+interface UseScreenOrientationValue {
+    /** The current angle */
+    angle: number;
+    /** The current orientation type */
+    orientationType: OrientationType;
+}
+type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
+interface useScreenOrientationReturn {
+    /** Whether the screen orientation is supported */
+    supported: boolean;
+    /** The current screen orientation value */
+    value: UseScreenOrientationValue;
+    /** Lock the screen orientation */
+    lock: (orientation: OrientationLockType) => void;
+    /** Unlock the screen orientation */
+    unlock: () => void;
+}
+/**
+ * @name useScreenOrientation
+ * @description - Hook that provides the current screen orientation
+ * @category Sensors
+ *
+ * @returns {useScreenOrientationReturn} The current screen orientation
+ *
+ * @example
+ * const { supported, value, lock, unlock } = useScreenOrientation();
+ */
+declare const useScreenOrientation: () => useScreenOrientationReturn;
+
 /** The use script status */
 type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
 declare const SCRIPT_STATUS_ATTRIBUTE_NAME = "script-status";
@@ -2907,4 +3026,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 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 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 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 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, 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, 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 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 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 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, 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, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@siberiacancode/reactuse",
   "type": "module",
-  "version": "0.0.65",
+  "version": "0.0.67",
   "description": "Ultimate tool",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",

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

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

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

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