@siberiacancode/reactuse 0.2.29 → 0.2.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -71
- package/dist/cjs/helpers/createContext/createContext.cjs.map +1 -1
- package/dist/cjs/helpers/createEventEmitter/createEventEmitter.cjs.map +1 -1
- package/dist/cjs/helpers/createReactiveContext/createReactiveContext.cjs.map +1 -1
- package/dist/cjs/helpers/createStore/createStore.cjs.map +1 -1
- package/dist/cjs/hooks/useActiveElement/useActiveElement.cjs.map +1 -1
- package/dist/cjs/hooks/useAsync/useAsync.cjs.map +1 -1
- package/dist/cjs/hooks/useAudio/useAudio.cjs.map +1 -1
- package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs +1 -1
- package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs.map +1 -1
- package/dist/cjs/hooks/useBattery/useBattery.cjs +1 -1
- package/dist/cjs/hooks/useBattery/useBattery.cjs.map +1 -1
- package/dist/cjs/hooks/useBluetooth/useBluetooth.cjs +1 -1
- package/dist/cjs/hooks/useBluetooth/useBluetooth.cjs.map +1 -1
- package/dist/cjs/hooks/useBoolean/useBoolean.cjs.map +1 -1
- package/dist/cjs/hooks/useBreakpoints/useBreakpoints.cjs.map +1 -1
- package/dist/cjs/hooks/useBroadcastChannel/useBroadcastChannel.cjs +1 -1
- package/dist/cjs/hooks/useBroadcastChannel/useBroadcastChannel.cjs.map +1 -1
- package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.cjs.map +1 -1
- package/dist/cjs/hooks/useClickOutside/useClickOutside.cjs.map +1 -1
- package/dist/cjs/hooks/useClipboard/useClipboard.cjs.map +1 -1
- package/dist/cjs/hooks/useConst/useConst.cjs.map +1 -1
- package/dist/cjs/hooks/useCookie/useCookie.cjs.map +1 -1
- package/dist/cjs/hooks/useCookies/useCookies.cjs.map +1 -1
- package/dist/cjs/hooks/useCopy/useCopy.cjs.map +1 -1
- package/dist/cjs/hooks/useCounter/useCounter.cjs.map +1 -1
- package/dist/cjs/hooks/useCssVar/useCssVar.cjs.map +1 -1
- package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.cjs.map +1 -1
- package/dist/cjs/hooks/useDebounceState/useDebounceState.cjs +2 -0
- package/dist/cjs/hooks/useDebounceState/useDebounceState.cjs.map +1 -0
- package/dist/cjs/hooks/useDebounceValue/useDebounceValue.cjs.map +1 -1
- package/dist/cjs/hooks/useDefault/useDefault.cjs.map +1 -1
- package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.cjs.map +1 -1
- package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.cjs +1 -1
- package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.cjs.map +1 -1
- package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.cjs +1 -1
- package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.cjs.map +1 -1
- package/dist/cjs/hooks/useDidUpdate/useDidUpdate.cjs.map +1 -1
- package/dist/cjs/hooks/useDisclosure/useDisclosure.cjs.map +1 -1
- package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.cjs.map +1 -1
- package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.cjs.map +1 -1
- package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.cjs.map +1 -1
- package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.cjs.map +1 -1
- package/dist/cjs/hooks/useDoubleClick/useDoubleClick.cjs.map +1 -1
- package/dist/cjs/hooks/useDropZone/useDropZone.cjs +1 -1
- package/dist/cjs/hooks/useDropZone/useDropZone.cjs.map +1 -1
- package/dist/cjs/hooks/useElementSize/useElementSize.cjs.map +1 -1
- package/dist/cjs/hooks/useEvent/useEvent.cjs.map +1 -1
- package/dist/cjs/hooks/useEventListener/useEventListener.cjs +1 -1
- package/dist/cjs/hooks/useEventListener/useEventListener.cjs.map +1 -1
- package/dist/cjs/hooks/useEventSource/useEventSource.cjs.map +1 -1
- package/dist/cjs/hooks/useEyeDropper/useEyeDropper.cjs +1 -1
- package/dist/cjs/hooks/useEyeDropper/useEyeDropper.cjs.map +1 -1
- package/dist/cjs/hooks/useFavicon/useFavicon.cjs +1 -1
- package/dist/cjs/hooks/useFavicon/useFavicon.cjs.map +1 -1
- package/dist/cjs/hooks/useField/useField.cjs.map +1 -1
- package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs +1 -1
- package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs.map +1 -1
- package/dist/cjs/hooks/useFocus/useFocus.cjs +1 -1
- package/dist/cjs/hooks/useFocus/useFocus.cjs.map +1 -1
- package/dist/cjs/hooks/useFps/useFps.cjs.map +1 -1
- package/dist/cjs/hooks/useFul/useFul.cjs.map +1 -1
- package/dist/cjs/hooks/useFullscreen/useFullscreen.cjs.map +1 -1
- package/dist/cjs/hooks/useGamepad/useGamepad.cjs +1 -1
- package/dist/cjs/hooks/useGamepad/useGamepad.cjs.map +1 -1
- package/dist/cjs/hooks/useGeolocation/useGeolocation.cjs.map +1 -1
- package/dist/cjs/hooks/useHash/useHash.cjs.map +1 -1
- package/dist/cjs/hooks/useHotkeys/useHotkeys.cjs.map +1 -1
- package/dist/cjs/hooks/useHover/useHover.cjs +1 -1
- package/dist/cjs/hooks/useHover/useHover.cjs.map +1 -1
- package/dist/cjs/hooks/useIdle/useIdle.cjs.map +1 -1
- package/dist/cjs/hooks/useImage/useImage.cjs.map +1 -1
- package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.cjs.map +1 -1
- package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs +1 -1
- package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs.map +1 -1
- package/dist/cjs/hooks/useInterval/useInterval.cjs.map +1 -1
- package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.cjs.map +1 -1
- package/dist/cjs/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.cjs.map +1 -1
- package/dist/cjs/hooks/useKeyPress/useKeyPress.cjs.map +1 -1
- package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.cjs.map +1 -1
- package/dist/cjs/hooks/useKeyboard/useKeyboard.cjs.map +1 -1
- package/dist/cjs/hooks/useKeysPressed/useKeysPressed.cjs.map +1 -1
- package/dist/cjs/hooks/useLastChanged/useLastChanged.cjs.map +1 -1
- package/dist/cjs/hooks/useLatest/useLatest.cjs.map +1 -1
- package/dist/cjs/hooks/useLess/useLess.cjs.map +1 -1
- package/dist/cjs/hooks/useList/useList.cjs.map +1 -1
- package/dist/cjs/hooks/useLocalStorage/useLocalStorage.cjs.map +1 -1
- package/dist/cjs/hooks/useLockCallback/useLockCallback.cjs.map +1 -1
- package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs +1 -1
- package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs.map +1 -1
- package/dist/cjs/hooks/useLogger/useLogger.cjs.map +1 -1
- package/dist/cjs/hooks/useLongPress/useLongPress.cjs.map +1 -1
- package/dist/cjs/hooks/useMap/useMap.cjs.map +1 -1
- package/dist/cjs/hooks/useMeasure/useMeasure.cjs.map +1 -1
- package/dist/cjs/hooks/useMediaControls/useMediaControls.cjs.map +1 -1
- package/dist/cjs/hooks/useMediaQuery/useMediaQuery.cjs.map +1 -1
- package/dist/cjs/hooks/useMemory/useMemory.cjs +1 -1
- package/dist/cjs/hooks/useMemory/useMemory.cjs.map +1 -1
- package/dist/cjs/hooks/useMergedRef/useMergedRef.cjs +2 -0
- package/dist/cjs/hooks/useMergedRef/useMergedRef.cjs.map +1 -0
- package/dist/cjs/hooks/useMount/useMount.cjs.map +1 -1
- package/dist/cjs/hooks/useMouse/useMouse.cjs.map +1 -1
- package/dist/cjs/hooks/useMutation/useMutation.cjs +1 -1
- package/dist/cjs/hooks/useMutation/useMutation.cjs.map +1 -1
- package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs +1 -1
- package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs.map +1 -1
- package/dist/cjs/hooks/useNetwork/useNetwork.cjs.map +1 -1
- package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.cjs.map +1 -1
- package/dist/cjs/hooks/useOnce/useOnce.cjs.map +1 -1
- package/dist/cjs/hooks/useOnline/useOnline.cjs.map +1 -1
- package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.cjs.map +1 -1
- package/dist/cjs/hooks/useOptimistic/useOptimistic.cjs.map +1 -1
- package/dist/cjs/hooks/useOrientation/useOrientation.cjs +1 -1
- package/dist/cjs/hooks/useOrientation/useOrientation.cjs.map +1 -1
- package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs +1 -1
- package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs.map +1 -1
- package/dist/cjs/hooks/usePageLeave/usePageLeave.cjs.map +1 -1
- package/dist/cjs/hooks/usePaint/usePaint.cjs.map +1 -1
- package/dist/cjs/hooks/useParallax/useParallax.cjs.map +1 -1
- package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.cjs +1 -1
- package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.cjs.map +1 -1
- package/dist/cjs/hooks/usePermission/usePermission.cjs +1 -1
- package/dist/cjs/hooks/usePermission/usePermission.cjs.map +1 -1
- package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs +1 -1
- package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs.map +1 -1
- package/dist/cjs/hooks/usePointerLock/usePointerLock.cjs +1 -1
- package/dist/cjs/hooks/usePointerLock/usePointerLock.cjs.map +1 -1
- package/dist/cjs/hooks/usePostMessage/usePostMessage.cjs.map +1 -1
- package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.cjs.map +1 -1
- package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.cjs.map +1 -1
- package/dist/cjs/hooks/usePreferredDark/usePreferredDark.cjs.map +1 -1
- package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.cjs.map +1 -1
- package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.cjs.map +1 -1
- package/dist/cjs/hooks/usePrevious/usePrevious.cjs.map +1 -1
- package/dist/cjs/hooks/useQuery/useQuery.cjs.map +1 -1
- package/dist/cjs/hooks/useQueue/useQueue.cjs.map +1 -1
- package/dist/cjs/hooks/useRaf/useRaf.cjs.map +1 -1
- package/dist/cjs/hooks/useRafState/useRafState.cjs.map +1 -1
- package/dist/cjs/hooks/useRefState/useRefState.cjs.map +1 -1
- package/dist/cjs/hooks/useRenderCount/useRenderCount.cjs.map +1 -1
- package/dist/cjs/hooks/useRenderInfo/useRenderInfo.cjs.map +1 -1
- package/dist/cjs/hooks/useRerender/useRerender.cjs.map +1 -1
- package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs +1 -1
- package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs.map +1 -1
- package/dist/cjs/hooks/useRightClick/useRightClick.cjs.map +1 -1
- package/dist/cjs/hooks/useScript/useScript.cjs.map +1 -1
- package/dist/cjs/hooks/useScroll/useScroll.cjs +1 -1
- package/dist/cjs/hooks/useScroll/useScroll.cjs.map +1 -1
- package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs +1 -1
- package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs.map +1 -1
- package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs +1 -1
- package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs.map +1 -1
- package/dist/cjs/hooks/useSessionStorage/useSessionStorage.cjs.map +1 -1
- package/dist/cjs/hooks/useSet/useSet.cjs.map +1 -1
- package/dist/cjs/hooks/useShallowEffect/useShallowEffect.cjs.map +1 -1
- package/dist/cjs/hooks/useShare/useShare.cjs +1 -1
- package/dist/cjs/hooks/useShare/useShare.cjs.map +1 -1
- package/dist/cjs/hooks/useSpeechRecognition/useSpeechRecognition.cjs.map +1 -1
- package/dist/cjs/hooks/useSpeechSynthesis/useSpeechSynthesis.cjs +1 -1
- package/dist/cjs/hooks/useSpeechSynthesis/useSpeechSynthesis.cjs.map +1 -1
- package/dist/cjs/hooks/useStateHistory/useStateHistory.cjs.map +1 -1
- package/dist/cjs/hooks/useStep/useStep.cjs.map +1 -1
- package/dist/cjs/hooks/useSticky/useSticky.cjs.map +1 -1
- package/dist/cjs/hooks/useStopwatch/useStopwatch.cjs.map +1 -1
- package/dist/cjs/hooks/useStorage/useStorage.cjs.map +1 -1
- package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs +1 -1
- package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs.map +1 -1
- package/dist/cjs/hooks/useTextSelection/useTextSelection.cjs.map +1 -1
- package/dist/cjs/hooks/useThrottleCallback/useThrottleCallback.cjs.map +1 -1
- package/dist/cjs/hooks/useThrottleState/useThrottleState.cjs +2 -0
- package/dist/cjs/hooks/useThrottleState/useThrottleState.cjs.map +1 -0
- package/dist/cjs/hooks/useThrottleValue/useThrottleValue.cjs.map +1 -1
- package/dist/cjs/hooks/useTime/useTime.cjs.map +1 -1
- package/dist/cjs/hooks/useTimeout/useTimeout.cjs.map +1 -1
- package/dist/cjs/hooks/useTimer/useTimer.cjs.map +1 -1
- package/dist/cjs/hooks/useToggle/useToggle.cjs.map +1 -1
- package/dist/cjs/hooks/useUnmount/useUnmount.cjs.map +1 -1
- package/dist/cjs/hooks/useUrlSearchParam/useUrlSearchParam.cjs.map +1 -1
- package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs.map +1 -1
- package/dist/cjs/hooks/useVibrate/useVibrate.cjs +1 -1
- package/dist/cjs/hooks/useVibrate/useVibrate.cjs.map +1 -1
- package/dist/cjs/hooks/useVirtualKeyboard/useVirtualKeyboard.cjs +1 -1
- package/dist/cjs/hooks/useVirtualKeyboard/useVirtualKeyboard.cjs.map +1 -1
- package/dist/cjs/hooks/useWakeLock/useWakeLock.cjs +1 -1
- package/dist/cjs/hooks/useWakeLock/useWakeLock.cjs.map +1 -1
- package/dist/cjs/hooks/useWebSocket/useWebSocket.cjs.map +1 -1
- package/dist/cjs/hooks/useWindowEvent/useWindowEvent.cjs.map +1 -1
- package/dist/cjs/hooks/useWindowFocus/useWindowFocus.cjs.map +1 -1
- package/dist/cjs/hooks/useWindowScroll/useWindowScroll.cjs.map +1 -1
- package/dist/cjs/hooks/useWindowSize/useWindowSize.cjs.map +1 -1
- package/dist/cjs/hooks/useWizard/useWizard.cjs.map +1 -1
- package/dist/cjs/index.cjs +1 -1
- package/dist/esm/helpers/createContext/createContext.mjs.map +1 -1
- package/dist/esm/helpers/createEventEmitter/createEventEmitter.mjs.map +1 -1
- package/dist/esm/helpers/createReactiveContext/createReactiveContext.mjs.map +1 -1
- package/dist/esm/helpers/createStore/createStore.mjs.map +1 -1
- package/dist/esm/hooks/useActiveElement/useActiveElement.mjs.map +1 -1
- package/dist/esm/hooks/useAsync/useAsync.mjs.map +1 -1
- package/dist/esm/hooks/useAudio/useAudio.mjs.map +1 -1
- package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs +25 -31
- package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs.map +1 -1
- package/dist/esm/hooks/useBattery/useBattery.mjs +1 -1
- package/dist/esm/hooks/useBattery/useBattery.mjs.map +1 -1
- package/dist/esm/hooks/useBluetooth/useBluetooth.mjs +16 -18
- package/dist/esm/hooks/useBluetooth/useBluetooth.mjs.map +1 -1
- package/dist/esm/hooks/useBoolean/useBoolean.mjs.map +1 -1
- package/dist/esm/hooks/useBreakpoints/useBreakpoints.mjs.map +1 -1
- package/dist/esm/hooks/useBroadcastChannel/useBroadcastChannel.mjs +8 -8
- package/dist/esm/hooks/useBroadcastChannel/useBroadcastChannel.mjs.map +1 -1
- package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.mjs.map +1 -1
- package/dist/esm/hooks/useClickOutside/useClickOutside.mjs.map +1 -1
- package/dist/esm/hooks/useClipboard/useClipboard.mjs.map +1 -1
- package/dist/esm/hooks/useConst/useConst.mjs.map +1 -1
- package/dist/esm/hooks/useCookie/useCookie.mjs.map +1 -1
- package/dist/esm/hooks/useCookies/useCookies.mjs.map +1 -1
- package/dist/esm/hooks/useCopy/useCopy.mjs.map +1 -1
- package/dist/esm/hooks/useCounter/useCounter.mjs.map +1 -1
- package/dist/esm/hooks/useCssVar/useCssVar.mjs.map +1 -1
- package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.mjs.map +1 -1
- package/dist/esm/hooks/useDebounceState/useDebounceState.mjs +10 -0
- package/dist/esm/hooks/useDebounceState/useDebounceState.mjs.map +1 -0
- package/dist/esm/hooks/useDebounceValue/useDebounceValue.mjs.map +1 -1
- package/dist/esm/hooks/useDefault/useDefault.mjs.map +1 -1
- package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.mjs.map +1 -1
- package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.mjs +1 -1
- package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.mjs.map +1 -1
- package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.mjs +1 -1
- package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.mjs.map +1 -1
- package/dist/esm/hooks/useDidUpdate/useDidUpdate.mjs.map +1 -1
- package/dist/esm/hooks/useDisclosure/useDisclosure.mjs.map +1 -1
- package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.mjs.map +1 -1
- package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.mjs.map +1 -1
- package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.mjs.map +1 -1
- package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.mjs.map +1 -1
- package/dist/esm/hooks/useDoubleClick/useDoubleClick.mjs.map +1 -1
- package/dist/esm/hooks/useDropZone/useDropZone.mjs +12 -12
- package/dist/esm/hooks/useDropZone/useDropZone.mjs.map +1 -1
- package/dist/esm/hooks/useElementSize/useElementSize.mjs.map +1 -1
- package/dist/esm/hooks/useEvent/useEvent.mjs.map +1 -1
- package/dist/esm/hooks/useEventListener/useEventListener.mjs +15 -15
- package/dist/esm/hooks/useEventListener/useEventListener.mjs.map +1 -1
- package/dist/esm/hooks/useEventSource/useEventSource.mjs.map +1 -1
- package/dist/esm/hooks/useEyeDropper/useEyeDropper.mjs +3 -3
- package/dist/esm/hooks/useEyeDropper/useEyeDropper.mjs.map +1 -1
- package/dist/esm/hooks/useFavicon/useFavicon.mjs +12 -15
- package/dist/esm/hooks/useFavicon/useFavicon.mjs.map +1 -1
- package/dist/esm/hooks/useField/useField.mjs.map +1 -1
- package/dist/esm/hooks/useFileDialog/useFileDialog.mjs +13 -13
- package/dist/esm/hooks/useFileDialog/useFileDialog.mjs.map +1 -1
- package/dist/esm/hooks/useFocus/useFocus.mjs +26 -22
- package/dist/esm/hooks/useFocus/useFocus.mjs.map +1 -1
- package/dist/esm/hooks/useFps/useFps.mjs.map +1 -1
- package/dist/esm/hooks/useFul/useFul.mjs.map +1 -1
- package/dist/esm/hooks/useFullscreen/useFullscreen.mjs.map +1 -1
- package/dist/esm/hooks/useGamepad/useGamepad.mjs +13 -13
- package/dist/esm/hooks/useGamepad/useGamepad.mjs.map +1 -1
- package/dist/esm/hooks/useGeolocation/useGeolocation.mjs.map +1 -1
- package/dist/esm/hooks/useHash/useHash.mjs.map +1 -1
- package/dist/esm/hooks/useHotkeys/useHotkeys.mjs.map +1 -1
- package/dist/esm/hooks/useHover/useHover.mjs +15 -15
- package/dist/esm/hooks/useHover/useHover.mjs.map +1 -1
- package/dist/esm/hooks/useIdle/useIdle.mjs.map +1 -1
- package/dist/esm/hooks/useImage/useImage.mjs.map +1 -1
- package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.mjs.map +1 -1
- package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs +19 -18
- package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs.map +1 -1
- package/dist/esm/hooks/useInterval/useInterval.mjs.map +1 -1
- package/dist/esm/hooks/useIsFirstRender/useIsFirstRender.mjs.map +1 -1
- package/dist/esm/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs.map +1 -1
- package/dist/esm/hooks/useKeyPress/useKeyPress.mjs.map +1 -1
- package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.mjs.map +1 -1
- package/dist/esm/hooks/useKeyboard/useKeyboard.mjs.map +1 -1
- package/dist/esm/hooks/useKeysPressed/useKeysPressed.mjs.map +1 -1
- package/dist/esm/hooks/useLastChanged/useLastChanged.mjs.map +1 -1
- package/dist/esm/hooks/useLatest/useLatest.mjs.map +1 -1
- package/dist/esm/hooks/useLess/useLess.mjs.map +1 -1
- package/dist/esm/hooks/useList/useList.mjs.map +1 -1
- package/dist/esm/hooks/useLocalStorage/useLocalStorage.mjs.map +1 -1
- package/dist/esm/hooks/useLockCallback/useLockCallback.mjs.map +1 -1
- package/dist/esm/hooks/useLockScroll/useLockScroll.mjs +24 -24
- package/dist/esm/hooks/useLockScroll/useLockScroll.mjs.map +1 -1
- package/dist/esm/hooks/useLogger/useLogger.mjs.map +1 -1
- package/dist/esm/hooks/useLongPress/useLongPress.mjs.map +1 -1
- package/dist/esm/hooks/useMap/useMap.mjs.map +1 -1
- package/dist/esm/hooks/useMeasure/useMeasure.mjs.map +1 -1
- package/dist/esm/hooks/useMediaControls/useMediaControls.mjs.map +1 -1
- package/dist/esm/hooks/useMediaQuery/useMediaQuery.mjs.map +1 -1
- package/dist/esm/hooks/useMemory/useMemory.mjs +4 -4
- package/dist/esm/hooks/useMemory/useMemory.mjs.map +1 -1
- package/dist/esm/hooks/useMergedRef/useMergedRef.mjs +25 -0
- package/dist/esm/hooks/useMergedRef/useMergedRef.mjs.map +1 -0
- package/dist/esm/hooks/useMount/useMount.mjs.map +1 -1
- package/dist/esm/hooks/useMouse/useMouse.mjs.map +1 -1
- package/dist/esm/hooks/useMutation/useMutation.mjs +18 -18
- package/dist/esm/hooks/useMutation/useMutation.mjs.map +1 -1
- package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs +28 -20
- package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs.map +1 -1
- package/dist/esm/hooks/useNetwork/useNetwork.mjs.map +1 -1
- package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.mjs.map +1 -1
- package/dist/esm/hooks/useOnce/useOnce.mjs.map +1 -1
- package/dist/esm/hooks/useOnline/useOnline.mjs.map +1 -1
- package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.mjs.map +1 -1
- package/dist/esm/hooks/useOptimistic/useOptimistic.mjs.map +1 -1
- package/dist/esm/hooks/useOrientation/useOrientation.mjs +9 -9
- package/dist/esm/hooks/useOrientation/useOrientation.mjs.map +1 -1
- package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs +3 -3
- package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs.map +1 -1
- package/dist/esm/hooks/usePageLeave/usePageLeave.mjs.map +1 -1
- package/dist/esm/hooks/usePaint/usePaint.mjs.map +1 -1
- package/dist/esm/hooks/useParallax/useParallax.mjs.map +1 -1
- package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.mjs +11 -11
- package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.mjs.map +1 -1
- package/dist/esm/hooks/usePermission/usePermission.mjs +4 -4
- package/dist/esm/hooks/usePermission/usePermission.mjs.map +1 -1
- package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs +17 -17
- package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs.map +1 -1
- package/dist/esm/hooks/usePointerLock/usePointerLock.mjs +3 -3
- package/dist/esm/hooks/usePointerLock/usePointerLock.mjs.map +1 -1
- package/dist/esm/hooks/usePostMessage/usePostMessage.mjs.map +1 -1
- package/dist/esm/hooks/usePreferredColorScheme/usePreferredColorScheme.mjs.map +1 -1
- package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.mjs.map +1 -1
- package/dist/esm/hooks/usePreferredDark/usePreferredDark.mjs.map +1 -1
- package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.mjs.map +1 -1
- package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.mjs.map +1 -1
- package/dist/esm/hooks/usePrevious/usePrevious.mjs.map +1 -1
- package/dist/esm/hooks/useQuery/useQuery.mjs.map +1 -1
- package/dist/esm/hooks/useQueue/useQueue.mjs.map +1 -1
- package/dist/esm/hooks/useRaf/useRaf.mjs.map +1 -1
- package/dist/esm/hooks/useRafState/useRafState.mjs.map +1 -1
- package/dist/esm/hooks/useRefState/useRefState.mjs.map +1 -1
- package/dist/esm/hooks/useRenderCount/useRenderCount.mjs.map +1 -1
- package/dist/esm/hooks/useRenderInfo/useRenderInfo.mjs.map +1 -1
- package/dist/esm/hooks/useRerender/useRerender.mjs.map +1 -1
- package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs +17 -16
- package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs.map +1 -1
- package/dist/esm/hooks/useRightClick/useRightClick.mjs.map +1 -1
- package/dist/esm/hooks/useScript/useScript.mjs.map +1 -1
- package/dist/esm/hooks/useScroll/useScroll.mjs +11 -13
- package/dist/esm/hooks/useScroll/useScroll.mjs.map +1 -1
- package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs +27 -27
- package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs.map +1 -1
- package/dist/esm/hooks/useScrollTo/useScrollTo.mjs +16 -16
- package/dist/esm/hooks/useScrollTo/useScrollTo.mjs.map +1 -1
- package/dist/esm/hooks/useSessionStorage/useSessionStorage.mjs.map +1 -1
- package/dist/esm/hooks/useSet/useSet.mjs.map +1 -1
- package/dist/esm/hooks/useShallowEffect/useShallowEffect.mjs.map +1 -1
- package/dist/esm/hooks/useShare/useShare.mjs +1 -1
- package/dist/esm/hooks/useShare/useShare.mjs.map +1 -1
- package/dist/esm/hooks/useSpeechRecognition/useSpeechRecognition.mjs.map +1 -1
- package/dist/esm/hooks/useSpeechSynthesis/useSpeechSynthesis.mjs +11 -11
- package/dist/esm/hooks/useSpeechSynthesis/useSpeechSynthesis.mjs.map +1 -1
- package/dist/esm/hooks/useStateHistory/useStateHistory.mjs.map +1 -1
- package/dist/esm/hooks/useStep/useStep.mjs.map +1 -1
- package/dist/esm/hooks/useSticky/useSticky.mjs.map +1 -1
- package/dist/esm/hooks/useStopwatch/useStopwatch.mjs.map +1 -1
- package/dist/esm/hooks/useStorage/useStorage.mjs.map +1 -1
- package/dist/esm/hooks/useTextDirection/useTextDirection.mjs +14 -14
- package/dist/esm/hooks/useTextDirection/useTextDirection.mjs.map +1 -1
- package/dist/esm/hooks/useTextSelection/useTextSelection.mjs.map +1 -1
- package/dist/esm/hooks/useThrottleCallback/useThrottleCallback.mjs.map +1 -1
- package/dist/esm/hooks/useThrottleState/useThrottleState.mjs +10 -0
- package/dist/esm/hooks/useThrottleState/useThrottleState.mjs.map +1 -0
- package/dist/esm/hooks/useThrottleValue/useThrottleValue.mjs.map +1 -1
- package/dist/esm/hooks/useTime/useTime.mjs.map +1 -1
- package/dist/esm/hooks/useTimeout/useTimeout.mjs.map +1 -1
- package/dist/esm/hooks/useTimer/useTimer.mjs.map +1 -1
- package/dist/esm/hooks/useToggle/useToggle.mjs.map +1 -1
- package/dist/esm/hooks/useUnmount/useUnmount.mjs.map +1 -1
- package/dist/esm/hooks/useUrlSearchParam/useUrlSearchParam.mjs.map +1 -1
- package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs.map +1 -1
- package/dist/esm/hooks/useVibrate/useVibrate.mjs +12 -12
- package/dist/esm/hooks/useVibrate/useVibrate.mjs.map +1 -1
- package/dist/esm/hooks/useVirtualKeyboard/useVirtualKeyboard.mjs +7 -7
- package/dist/esm/hooks/useVirtualKeyboard/useVirtualKeyboard.mjs.map +1 -1
- package/dist/esm/hooks/useWakeLock/useWakeLock.mjs +1 -1
- package/dist/esm/hooks/useWakeLock/useWakeLock.mjs.map +1 -1
- package/dist/esm/hooks/useWebSocket/useWebSocket.mjs.map +1 -1
- package/dist/esm/hooks/useWindowEvent/useWindowEvent.mjs.map +1 -1
- package/dist/esm/hooks/useWindowFocus/useWindowFocus.mjs.map +1 -1
- package/dist/esm/hooks/useWindowScroll/useWindowScroll.mjs.map +1 -1
- package/dist/esm/hooks/useWindowSize/useWindowSize.mjs.map +1 -1
- package/dist/esm/hooks/useWizard/useWizard.mjs.map +1 -1
- package/dist/esm/index.mjs +147 -139
- package/dist/esm/index.mjs.map +1 -1
- package/dist/types/helpers/createContext/createContext.d.ts +1 -0
- package/dist/types/helpers/createEventEmitter/createEventEmitter.d.ts +1 -0
- package/dist/types/helpers/createReactiveContext/createReactiveContext.d.ts +1 -0
- package/dist/types/helpers/createStore/createStore.d.ts +1 -0
- package/dist/types/hooks/state.d.ts +1 -0
- package/dist/types/hooks/useActiveElement/useActiveElement.d.ts +1 -0
- package/dist/types/hooks/useAsync/useAsync.d.ts +1 -0
- package/dist/types/hooks/useAudio/useAudio.d.ts +2 -1
- package/dist/types/hooks/useAutoScroll/useAutoScroll.d.ts +1 -0
- package/dist/types/hooks/useBattery/useBattery.d.ts +1 -0
- package/dist/types/hooks/useBluetooth/useBluetooth.d.ts +1 -0
- package/dist/types/hooks/useBoolean/useBoolean.d.ts +2 -1
- package/dist/types/hooks/useBreakpoints/useBreakpoints.d.ts +1 -0
- package/dist/types/hooks/useBroadcastChannel/useBroadcastChannel.d.ts +1 -0
- package/dist/types/hooks/useBrowserLanguage/useBrowserLanguage.d.ts +2 -1
- package/dist/types/hooks/useClickOutside/useClickOutside.d.ts +2 -1
- package/dist/types/hooks/useClipboard/useClipboard.d.ts +2 -1
- package/dist/types/hooks/useConst/useConst.d.ts +2 -1
- package/dist/types/hooks/useCookie/useCookie.d.ts +2 -1
- package/dist/types/hooks/useCookies/useCookies.d.ts +2 -1
- package/dist/types/hooks/useCopy/useCopy.d.ts +2 -1
- package/dist/types/hooks/useCounter/useCounter.d.ts +2 -1
- package/dist/types/hooks/useCssVar/useCssVar.d.ts +2 -1
- package/dist/types/hooks/useDebounceCallback/useDebounceCallback.d.ts +1 -0
- package/dist/types/hooks/useDebounceState/useDebounceState.d.ts +15 -0
- package/dist/types/hooks/useDebounceValue/useDebounceValue.d.ts +2 -1
- package/dist/types/hooks/useDefault/useDefault.d.ts +2 -1
- package/dist/types/hooks/useDeviceMotion/useDeviceMotion.d.ts +2 -1
- package/dist/types/hooks/useDeviceOrientation/useDeviceOrientation.d.ts +1 -0
- package/dist/types/hooks/useDevicePixelRatio/useDevicePixelRatio.d.ts +1 -0
- package/dist/types/hooks/useDidUpdate/useDidUpdate.d.ts +2 -1
- package/dist/types/hooks/useDisclosure/useDisclosure.d.ts +2 -1
- package/dist/types/hooks/useDisplayMedia/useDisplayMedia.d.ts +1 -0
- package/dist/types/hooks/useDocumentEvent/useDocumentEvent.d.ts +2 -1
- package/dist/types/hooks/useDocumentTitle/useDocumentTitle.d.ts +2 -1
- package/dist/types/hooks/useDocumentVisibility/useDocumentVisibility.d.ts +2 -1
- package/dist/types/hooks/useDoubleClick/useDoubleClick.d.ts +2 -1
- package/dist/types/hooks/useDropZone/useDropZone.d.ts +2 -1
- package/dist/types/hooks/useElementSize/useElementSize.d.ts +2 -1
- package/dist/types/hooks/useEvent/useEvent.d.ts +2 -1
- package/dist/types/hooks/useEventListener/useEventListener.d.ts +5 -2
- package/dist/types/hooks/useEventSource/useEventSource.d.ts +1 -0
- package/dist/types/hooks/useEyeDropper/useEyeDropper.d.ts +1 -0
- package/dist/types/hooks/useFavicon/useFavicon.d.ts +2 -1
- package/dist/types/hooks/useField/useField.d.ts +1 -0
- package/dist/types/hooks/useFileDialog/useFileDialog.d.ts +1 -0
- package/dist/types/hooks/useFocus/useFocus.d.ts +25 -0
- package/dist/types/hooks/useFps/useFps.d.ts +1 -0
- package/dist/types/hooks/useFul/useFul.d.ts +1 -0
- package/dist/types/hooks/useFullscreen/useFullscreen.d.ts +1 -0
- package/dist/types/hooks/useGamepad/useGamepad.d.ts +1 -0
- package/dist/types/hooks/useGeolocation/useGeolocation.d.ts +1 -0
- package/dist/types/hooks/useHash/useHash.d.ts +1 -0
- package/dist/types/hooks/useHotkeys/useHotkeys.d.ts +1 -0
- package/dist/types/hooks/useHover/useHover.d.ts +3 -0
- package/dist/types/hooks/useIdle/useIdle.d.ts +1 -0
- package/dist/types/hooks/useImage/useImage.d.ts +1 -0
- package/dist/types/hooks/useInfiniteScroll/useInfiniteScroll.d.ts +1 -0
- package/dist/types/hooks/useIntersectionObserver/useIntersectionObserver.d.ts +15 -6
- package/dist/types/hooks/useInterval/useInterval.d.ts +1 -0
- package/dist/types/hooks/useIsFirstRender/useIsFirstRender.d.ts +1 -0
- package/dist/types/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts +1 -0
- package/dist/types/hooks/useKeyPress/useKeyPress.d.ts +1 -0
- package/dist/types/hooks/useKeyPressEvent/useKeyPressEvent.d.ts +1 -0
- package/dist/types/hooks/useKeyboard/useKeyboard.d.ts +1 -0
- package/dist/types/hooks/useKeysPressed/useKeysPressed.d.ts +1 -2
- package/dist/types/hooks/useLastChanged/useLastChanged.d.ts +1 -0
- package/dist/types/hooks/useLatest/useLatest.d.ts +1 -0
- package/dist/types/hooks/useLess/useLess.d.ts +1 -0
- package/dist/types/hooks/useList/useList.d.ts +1 -0
- package/dist/types/hooks/useLocalStorage/useLocalStorage.d.ts +1 -0
- package/dist/types/hooks/useLockCallback/useLockCallback.d.ts +1 -0
- package/dist/types/hooks/useLockScroll/useLockScroll.d.ts +1 -1
- package/dist/types/hooks/useLogger/useLogger.d.ts +1 -0
- package/dist/types/hooks/useLongPress/useLongPress.d.ts +1 -0
- package/dist/types/hooks/useMap/useMap.d.ts +1 -0
- package/dist/types/hooks/useMeasure/useMeasure.d.ts +1 -0
- package/dist/types/hooks/useMediaControls/useMediaControls.d.ts +1 -0
- package/dist/types/hooks/useMediaQuery/useMediaQuery.d.ts +1 -0
- package/dist/types/hooks/useMemory/useMemory.d.ts +1 -0
- package/dist/types/hooks/useMergedRef/useMergedRef.d.ts +17 -0
- package/dist/types/hooks/useMount/useMount.d.ts +1 -0
- package/dist/types/hooks/useMouse/useMouse.d.ts +1 -0
- package/dist/types/hooks/useMutation/useMutation.d.ts +1 -0
- package/dist/types/hooks/useMutationObserver/useMutationObserver.d.ts +43 -26
- package/dist/types/hooks/useNetwork/useNetwork.d.ts +1 -0
- package/dist/types/hooks/useObject/useObject.d.ts +1 -0
- package/dist/types/hooks/useOffsetPagination/useOffsetPagination.d.ts +1 -0
- package/dist/types/hooks/useOnce/useOnce.d.ts +1 -0
- package/dist/types/hooks/useOnline/useOnline.d.ts +1 -0
- package/dist/types/hooks/useOperatingSystem/useOperatingSystem.d.ts +1 -0
- package/dist/types/hooks/useOptimistic/useOptimistic.d.ts +1 -0
- package/dist/types/hooks/useOrientation/useOrientation.d.ts +2 -1
- package/dist/types/hooks/useOtpCredential/useOtpCredential.d.ts +1 -0
- package/dist/types/hooks/usePageLeave/usePageLeave.d.ts +1 -0
- package/dist/types/hooks/usePaint/usePaint.d.ts +1 -0
- package/dist/types/hooks/useParallax/useParallax.d.ts +1 -0
- package/dist/types/hooks/usePerformanceObserver/usePerformanceObserver.d.ts +1 -0
- package/dist/types/hooks/usePermission/usePermission.d.ts +1 -0
- package/dist/types/hooks/usePictureInPicture/usePictureInPicture.d.ts +1 -0
- package/dist/types/hooks/usePointerLock/usePointerLock.d.ts +1 -0
- package/dist/types/hooks/usePostMessage/usePostMessage.d.ts +1 -0
- package/dist/types/hooks/usePreferredColorScheme/usePreferredColorScheme.d.ts +1 -0
- package/dist/types/hooks/usePreferredContrast/usePreferredContrast.d.ts +1 -0
- package/dist/types/hooks/usePreferredDark/usePreferredDark.d.ts +1 -0
- package/dist/types/hooks/usePreferredLanguages/usePreferredLanguages.d.ts +1 -0
- package/dist/types/hooks/usePreferredReducedMotion/usePreferredReducedMotion.d.ts +1 -0
- package/dist/types/hooks/usePrevious/usePrevious.d.ts +1 -0
- package/dist/types/hooks/useQuery/useQuery.d.ts +1 -0
- package/dist/types/hooks/useQueue/useQueue.d.ts +1 -0
- package/dist/types/hooks/useRaf/useRaf.d.ts +1 -0
- package/dist/types/hooks/useRafState/useRafState.d.ts +3 -0
- package/dist/types/hooks/useRefState/useRefState.d.ts +1 -0
- package/dist/types/hooks/useRenderCount/useRenderCount.d.ts +1 -0
- package/dist/types/hooks/useRenderInfo/useRenderInfo.d.ts +1 -0
- package/dist/types/hooks/useRerender/useRerender.d.ts +1 -0
- package/dist/types/hooks/useResizeObserver/useResizeObserver.d.ts +55 -31
- package/dist/types/hooks/useRightClick/useRightClick.d.ts +1 -0
- package/dist/types/hooks/useScript/useScript.d.ts +1 -0
- package/dist/types/hooks/useScroll/useScroll.d.ts +4 -3
- package/dist/types/hooks/useScrollIntoView/useScrollIntoView.d.ts +7 -4
- package/dist/types/hooks/useScrollTo/useScrollTo.d.ts +13 -6
- package/dist/types/hooks/useSessionStorage/useSessionStorage.d.ts +1 -0
- package/dist/types/hooks/useSet/useSet.d.ts +1 -0
- package/dist/types/hooks/useShallowEffect/useShallowEffect.d.ts +1 -0
- package/dist/types/hooks/useShare/useShare.d.ts +1 -0
- package/dist/types/hooks/useSpeechRecognition/useSpeechRecognition.d.ts +1 -0
- package/dist/types/hooks/useSpeechSynthesis/useSpeechSynthesis.d.ts +1 -0
- package/dist/types/hooks/useStateHistory/useStateHistory.d.ts +1 -0
- package/dist/types/hooks/useStep/useStep.d.ts +1 -0
- package/dist/types/hooks/useSticky/useSticky.d.ts +1 -0
- package/dist/types/hooks/useStopwatch/useStopwatch.d.ts +1 -0
- package/dist/types/hooks/useStorage/useStorage.d.ts +1 -0
- package/dist/types/hooks/useTextDirection/useTextDirection.d.ts +1 -0
- package/dist/types/hooks/useTextSelection/useTextSelection.d.ts +1 -0
- package/dist/types/hooks/useThrottleCallback/useThrottleCallback.d.ts +1 -0
- package/dist/types/hooks/useThrottleState/useThrottleState.d.ts +15 -0
- package/dist/types/hooks/useThrottleValue/useThrottleValue.d.ts +1 -0
- package/dist/types/hooks/useTime/useTime.d.ts +1 -0
- package/dist/types/hooks/useTimeout/useTimeout.d.ts +1 -0
- package/dist/types/hooks/useTimer/useTimer.d.ts +1 -0
- package/dist/types/hooks/useToggle/useToggle.d.ts +1 -0
- package/dist/types/hooks/useUnmount/useUnmount.d.ts +1 -0
- package/dist/types/hooks/useUrlSearchParam/useUrlSearchParam.d.ts +1 -0
- package/dist/types/hooks/useUrlSearchParams/useUrlSearchParams.d.ts +1 -0
- package/dist/types/hooks/useVibrate/useVibrate.d.ts +1 -0
- package/dist/types/hooks/useVirtualKeyboard/useVirtualKeyboard.d.ts +1 -0
- package/dist/types/hooks/useWakeLock/useWakeLock.d.ts +1 -0
- package/dist/types/hooks/useWebSocket/useWebSocket.d.ts +17 -0
- package/dist/types/hooks/useWindowEvent/useWindowEvent.d.ts +1 -0
- package/dist/types/hooks/useWindowFocus/useWindowFocus.d.ts +1 -0
- package/dist/types/hooks/useWindowScroll/useWindowScroll.d.ts +1 -0
- package/dist/types/hooks/useWindowSize/useWindowSize.d.ts +1 -0
- package/dist/types/hooks/useWizard/useWizard.d.ts +1 -0
- package/dist/types/hooks/utilities.d.ts +2 -0
- package/package.json +89 -89
|
@@ -10,7 +10,8 @@ export declare const clearCookies: () => void;
|
|
|
10
10
|
* @name useCookies
|
|
11
11
|
* @description - Hook that manages cookie values
|
|
12
12
|
* @category State
|
|
13
|
-
*
|
|
13
|
+
* @usage medium
|
|
14
|
+
|
|
14
15
|
* @overload
|
|
15
16
|
* @template {object} Value The type of the cookie values
|
|
16
17
|
* @returns {UseCookieReturn<Value>} The value and the set function
|
|
@@ -16,7 +16,8 @@ export interface UseCopyParams {
|
|
|
16
16
|
* @name useCopy
|
|
17
17
|
* @description - Hook that manages copying text with status reset
|
|
18
18
|
* @category Browser
|
|
19
|
-
*
|
|
19
|
+
* @usage medium
|
|
20
|
+
|
|
20
21
|
* @browserapi navigator.clipboard https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clipboard
|
|
21
22
|
*
|
|
22
23
|
* @param {number} [delay=1000] Delay in ms before resetting copied status
|
|
@@ -29,7 +29,8 @@ export interface UseCounter {
|
|
|
29
29
|
* @name useCounter
|
|
30
30
|
* @description - Hook that manages a counter
|
|
31
31
|
* @category State
|
|
32
|
-
*
|
|
32
|
+
* @usage low
|
|
33
|
+
|
|
33
34
|
* @overload
|
|
34
35
|
* @param {number} [initialValue=0] The initial number value
|
|
35
36
|
* @param {number} [options.min=Number.NEGATIVE_INFINITY] The min of count value
|
|
@@ -19,7 +19,8 @@ export interface UseCssVar {
|
|
|
19
19
|
* @name useCssVar
|
|
20
20
|
* @description - Hook that returns the value of a css variable
|
|
21
21
|
* @category Browser
|
|
22
|
-
*
|
|
22
|
+
* @usage low
|
|
23
|
+
|
|
23
24
|
* @overload
|
|
24
25
|
* @param {string} key The CSS variable key
|
|
25
26
|
* @param {string} initialValue The initial value of the CSS variable
|
|
@@ -5,6 +5,7 @@ export type DebouncedCallback<Params extends unknown[]> = ((...args: Params) =>
|
|
|
5
5
|
* @name useDebounceCallback
|
|
6
6
|
* @description - Hook that creates a debounced callback
|
|
7
7
|
* @category Utilities
|
|
8
|
+
* @usage high
|
|
8
9
|
*
|
|
9
10
|
* @template Params The type of the params
|
|
10
11
|
* @template Return The type of the return
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name useDebounceState
|
|
3
|
+
* @description - Hook that creates a debounced state
|
|
4
|
+
* @category Utilities
|
|
5
|
+
* @usage high
|
|
6
|
+
|
|
7
|
+
* @template Value The type of the value
|
|
8
|
+
* @param {Value} value The value to be debounced
|
|
9
|
+
* @param {number} delay The delay in milliseconds
|
|
10
|
+
* @returns {[Value, (value: Value) => void]} The debounced state
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* const [debouncedValue, setDebouncedValue] = useDebounceState(value, 500);
|
|
14
|
+
*/
|
|
15
|
+
export declare const useDebounceState: <Value>(initialValue: Value, delay: number) => readonly [Value, import('..').DebouncedCallback<[value: import('react').SetStateAction<Value>]>];
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* @name useDebounceValue
|
|
3
3
|
* @description - Hook that creates a debounced value
|
|
4
4
|
* @category Utilities
|
|
5
|
-
*
|
|
5
|
+
* @usage high
|
|
6
|
+
|
|
6
7
|
* @template Value The type of the value
|
|
7
8
|
* @param {Value} value The value to be debounced
|
|
8
9
|
* @param {number} delay The delay in milliseconds
|
|
@@ -15,7 +15,8 @@ export interface UseDeviceMotionParams {
|
|
|
15
15
|
/**
|
|
16
16
|
* @name useDeviceMotion
|
|
17
17
|
* @description - Hook that work with device motion
|
|
18
|
-
* @category
|
|
18
|
+
* @category Sensors
|
|
19
|
+
* @usage low
|
|
19
20
|
*
|
|
20
21
|
* @browserapi DeviceMotionEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceMotionEvent
|
|
21
22
|
*
|
|
@@ -18,6 +18,7 @@ export interface UseDeviceOrientationReturn {
|
|
|
18
18
|
* @name useDeviceOrientation
|
|
19
19
|
* @description - Hook that provides the current device orientation
|
|
20
20
|
* @category Sensors
|
|
21
|
+
* @usage low
|
|
21
22
|
*
|
|
22
23
|
* @browserapi DeviceOrientationEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceOrientationEvent
|
|
23
24
|
*
|
|
@@ -9,6 +9,7 @@ export interface UseDevicePixelRatioReturn {
|
|
|
9
9
|
* @name useDevicePixelRatio
|
|
10
10
|
* @description - Hook that returns the device's pixel ratio
|
|
11
11
|
* @category Utilities
|
|
12
|
+
* @usage low
|
|
12
13
|
*
|
|
13
14
|
* @browserapi window.devicePixelRatio https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
|
|
14
15
|
*
|
|
@@ -3,7 +3,8 @@ import { DependencyList, EffectCallback } from 'react';
|
|
|
3
3
|
* @name useDidUpdate
|
|
4
4
|
* @description – Hook that triggers the effect callback on updates
|
|
5
5
|
* @category Lifecycle
|
|
6
|
-
*
|
|
6
|
+
* @usage necessary
|
|
7
|
+
|
|
7
8
|
* @param {EffectCallback} effect The effect callback
|
|
8
9
|
* @param {DependencyList} [deps] The dependencies list for the effect
|
|
9
10
|
*
|
|
@@ -20,7 +20,8 @@ export interface UseDisclosureReturn {
|
|
|
20
20
|
* @name useDisclosure
|
|
21
21
|
* @description - Hook that allows you to open and close a modal
|
|
22
22
|
* @category State
|
|
23
|
-
*
|
|
23
|
+
* @usage necessary
|
|
24
|
+
|
|
24
25
|
* @param {boolean} [initialValue=false] The initial value of the component
|
|
25
26
|
* @param {() => void} [options.onOpen] The callback function to be invoked on open
|
|
26
27
|
* @param {() => void} [options.onClose] The callback function to be invoked on close
|
|
@@ -32,6 +32,7 @@ export interface UseDisplayMedia {
|
|
|
32
32
|
* @name useDisplayMedia
|
|
33
33
|
* @description - Hook that provides screen sharing functionality
|
|
34
34
|
* @category Browser
|
|
35
|
+
* @usage low
|
|
35
36
|
*
|
|
36
37
|
* @browserapi mediaDevices.getDisplayMedia https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia
|
|
37
38
|
*
|
|
@@ -3,7 +3,8 @@ import { UseEventListenerOptions } from '../useEventListener/useEventListener';
|
|
|
3
3
|
* @name useDocumentEvent
|
|
4
4
|
* @description - Hook attaches an event listener to the document object for the specified event
|
|
5
5
|
* @category Browser
|
|
6
|
-
*
|
|
6
|
+
* @usage low
|
|
7
|
+
|
|
7
8
|
* @template Event Key of document event map.
|
|
8
9
|
* @param {Event} event The event to listen for.
|
|
9
10
|
* @param {(event: DocumentEventMap[Event]) => void} listener The callback function to be executed when the event is triggered
|
|
@@ -14,7 +14,8 @@ export interface UseDocumentTitleReturn {
|
|
|
14
14
|
* @name useDocumentTitle
|
|
15
15
|
* @description - Hook that manages the document title and allows updating it
|
|
16
16
|
* @category Browser
|
|
17
|
-
*
|
|
17
|
+
* @usage low
|
|
18
|
+
|
|
18
19
|
* @browserapi document.title https://developer.mozilla.org/en-US/docs/Web/API/Document/title
|
|
19
20
|
*
|
|
20
21
|
* @param {string} [initialValue] The initial title. If not provided, the current document title will be used
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* @name useDocumentVisibility
|
|
3
3
|
* @description – Hook that provides the current visibility state of the document
|
|
4
4
|
* @category Browser
|
|
5
|
-
*
|
|
5
|
+
* @usage low
|
|
6
|
+
|
|
6
7
|
* @returns {DocumentVisibilityState} The current visibility state of the document, which can be 'visible' or 'hidden'
|
|
7
8
|
*
|
|
8
9
|
* @example
|
|
@@ -17,7 +17,8 @@ export declare const DEFAULT_THRESHOLD_TIME = 300;
|
|
|
17
17
|
* @name useDoubleClick
|
|
18
18
|
* @description - Hook that defines the logic when double clicking an element
|
|
19
19
|
* @category Elements
|
|
20
|
-
*
|
|
20
|
+
* @usage medium
|
|
21
|
+
|
|
21
22
|
* @overload
|
|
22
23
|
* @param {HookTarget} target The target element to be double clicked
|
|
23
24
|
* @param {(event: DoubleClickEvents) => void} callback The callback function to be invoked on double click
|
|
@@ -35,7 +35,8 @@ export interface UseDropZone {
|
|
|
35
35
|
* @name useDropZone
|
|
36
36
|
* @description - Hook that provides drop zone functionality
|
|
37
37
|
* @category Elements
|
|
38
|
-
*
|
|
38
|
+
* @usage medium
|
|
39
|
+
|
|
39
40
|
* @overload
|
|
40
41
|
* @template Target The target element
|
|
41
42
|
* @param {Target} target The target element drop zone's
|
|
@@ -21,7 +21,8 @@ export interface UseElementSize {
|
|
|
21
21
|
* @name useElementSize
|
|
22
22
|
* @description - Hook that observes and returns the width and height of element
|
|
23
23
|
* @category Elements
|
|
24
|
-
*
|
|
24
|
+
* @usage low
|
|
25
|
+
|
|
25
26
|
* @overload
|
|
26
27
|
* @param {HookTarget} target The target element to observe
|
|
27
28
|
* @returns {UseElementSizeReturn} An object containing the current width and height of the element
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* @name useEvent
|
|
3
3
|
* @description - Hook that creates an event and returns a stable reference of it
|
|
4
4
|
* @category Utilities
|
|
5
|
-
*
|
|
5
|
+
* @usage high
|
|
6
|
+
|
|
6
7
|
* @template Params The type of the params
|
|
7
8
|
* @template Return The type of the return
|
|
8
9
|
* @param {(...args: Params) => Return} callback The callback function
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { HookTarget } from '../../utils/helpers';
|
|
2
2
|
import { StateRef } from '../useRefState/useRefState';
|
|
3
3
|
/** The use event listener options */
|
|
4
|
-
export type UseEventListenerOptions =
|
|
4
|
+
export type UseEventListenerOptions = {
|
|
5
|
+
enabled?: boolean;
|
|
6
|
+
} & AddEventListenerOptions;
|
|
5
7
|
/** The use event listener return type */
|
|
6
8
|
export type UseEventListenerReturn<Target extends Element> = StateRef<Target>;
|
|
7
9
|
export interface UseEventListener {
|
|
@@ -15,7 +17,8 @@ export interface UseEventListener {
|
|
|
15
17
|
* @name useEventListener
|
|
16
18
|
* @description - Hook that attaches an event listener to the specified target
|
|
17
19
|
* @category Browser
|
|
18
|
-
*
|
|
20
|
+
* @usage necessary
|
|
21
|
+
|
|
19
22
|
* @overload
|
|
20
23
|
* @template Event Key of window event map
|
|
21
24
|
* @param {Window} target The window object to attach the event listener to
|
|
@@ -32,6 +32,7 @@ interface UseEventSourceReturn<Data = any> {
|
|
|
32
32
|
* @name useEventSource
|
|
33
33
|
* @description - Hook that provides a reactive wrapper for event source
|
|
34
34
|
* @category Browser
|
|
35
|
+
* @usage low
|
|
35
36
|
*
|
|
36
37
|
* @browserapi EventSource https://developer.mozilla.org/en-US/docs/Web/API/EventSource
|
|
37
38
|
*
|
|
@@ -28,6 +28,7 @@ export interface UseEyeDropperReturn {
|
|
|
28
28
|
* @name useEyeDropper
|
|
29
29
|
* @description - Hook that gives you access to the eye dropper
|
|
30
30
|
* @category Browser
|
|
31
|
+
* @usage low
|
|
31
32
|
*
|
|
32
33
|
* @browserapi EyeDropper https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper
|
|
33
34
|
*
|
|
@@ -5,12 +5,13 @@ export type UseFaviconReturn = [string, Dispatch<SetStateAction<string>>];
|
|
|
5
5
|
* @name useFavicon
|
|
6
6
|
* @description - Hook that manages the favicon
|
|
7
7
|
* @category Browser
|
|
8
|
+
* @usage low
|
|
8
9
|
*
|
|
9
10
|
* @param {string} [initialFavicon] The initial favicon. If not provided, the current favicon will be used
|
|
10
11
|
* @returns {UseFaviconReturn} An array containing the current favicon and a function to update the favicon
|
|
11
12
|
*
|
|
12
13
|
* @example
|
|
13
|
-
* const { href, set } = useFavicon('https://
|
|
14
|
+
* const { href, set } = useFavicon('https://siberiacancode.github.io/reactuse/favicon.ico');
|
|
14
15
|
*/
|
|
15
16
|
export declare const useFavicon: (initialHref?: string) => {
|
|
16
17
|
readonly href: string | undefined;
|
|
@@ -21,6 +21,7 @@ export interface UseFileDialog {
|
|
|
21
21
|
* @name useFileDialog
|
|
22
22
|
* @description - Hook to handle file input
|
|
23
23
|
* @category Elements
|
|
24
|
+
* @usage low
|
|
24
25
|
*
|
|
25
26
|
* @overload
|
|
26
27
|
* @param {(value: FileList | null) => void} callback The callback to execute when a file is selected
|
|
@@ -2,6 +2,8 @@ import { HookTarget } from '../../utils/helpers';
|
|
|
2
2
|
import { StateRef } from '../useRefState/useRefState';
|
|
3
3
|
/** The use focus options type */
|
|
4
4
|
export interface UseFocusOptions {
|
|
5
|
+
/** The enabled state of the focus hook */
|
|
6
|
+
enabled?: boolean;
|
|
5
7
|
/** The initial focus state of the target */
|
|
6
8
|
initialValue?: boolean;
|
|
7
9
|
/** The on blur callback */
|
|
@@ -19,7 +21,11 @@ export interface UseFocusReturn {
|
|
|
19
21
|
focus: () => void;
|
|
20
22
|
}
|
|
21
23
|
export interface UseFocus {
|
|
24
|
+
(target: HookTarget, callback?: (event: FocusEvent) => void): UseFocusReturn;
|
|
22
25
|
(target: HookTarget, options?: UseFocusOptions): UseFocusReturn;
|
|
26
|
+
<Target extends Element>(callback?: (event: FocusEvent) => void, target?: never): UseFocusReturn & {
|
|
27
|
+
ref: StateRef<Target>;
|
|
28
|
+
};
|
|
23
29
|
<Target extends Element>(options?: UseFocusOptions, target?: never): UseFocusReturn & {
|
|
24
30
|
ref: StateRef<Target>;
|
|
25
31
|
};
|
|
@@ -28,9 +34,19 @@ export interface UseFocus {
|
|
|
28
34
|
* @name useFocus
|
|
29
35
|
* @description - Hook that allows you to focus on a specific element
|
|
30
36
|
* @category Elements
|
|
37
|
+
* @usage medium
|
|
38
|
+
*
|
|
39
|
+
* @overload
|
|
40
|
+
* @param {HookTarget} target The target element to focus
|
|
41
|
+
* @param {(event: FocusEvent) => void} [callback] The callback function to be invoked on focus
|
|
42
|
+
* @returns {UseFocusReturn} An object with focus state and methods
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* const { focus, blur, focused } = useFocus(ref, () => console.log('focused'));
|
|
31
46
|
*
|
|
32
47
|
* @overload
|
|
33
48
|
* @param {HookTarget} target The target element to focus
|
|
49
|
+
* @param {boolean} [options.enabled=true] The enabled state of the focus hook
|
|
34
50
|
* @param {boolean} [options.initialValue=false] The initial focus state of the target
|
|
35
51
|
* @param {(event: FocusEvent) => void} [options.onFocus] The callback function to be invoked on focus
|
|
36
52
|
* @param {(event: FocusEvent) => void} [options.onBlur] The callback function to be invoked on blur
|
|
@@ -41,6 +57,15 @@ export interface UseFocus {
|
|
|
41
57
|
*
|
|
42
58
|
* @overload
|
|
43
59
|
* @template Target The target element
|
|
60
|
+
* @param {(event: FocusEvent) => void} [callback] The callback function to be invoked on focus
|
|
61
|
+
* @returns {UseFocusReturn & { ref: StateRef<Target> }} An object with focus state, methods and ref
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* const { ref, focus, blur, focused } = useFocus(() => console.log('focused'));
|
|
65
|
+
*
|
|
66
|
+
* @overload
|
|
67
|
+
* @template Target The target element
|
|
68
|
+
* @param {boolean} [options.enabled=true] The enabled state of the focus hook
|
|
44
69
|
* @param {boolean} [options.initialValue=false] The initial focus state of the target
|
|
45
70
|
* @param {(event: FocusEvent) => void} [options.onFocus] The callback function to be invoked on focus
|
|
46
71
|
* @param {(event: FocusEvent) => void} [options.onBlur] The callback function to be invoked on blur
|
|
@@ -16,6 +16,7 @@ export interface UseGamepadStateReturn {
|
|
|
16
16
|
* @name useGamepad
|
|
17
17
|
* @description - Hook for getting information about gamepad
|
|
18
18
|
* @category Browser
|
|
19
|
+
* @usage low
|
|
19
20
|
*
|
|
20
21
|
* @browserapi navigator.getGamepads https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getGamepads
|
|
21
22
|
*
|
|
@@ -27,6 +27,7 @@ export type UseGeolocationParams = PositionOptions;
|
|
|
27
27
|
* @name useGeolocation
|
|
28
28
|
* @description - Hook that returns the current geolocation
|
|
29
29
|
* @category Browser
|
|
30
|
+
* @usage medium
|
|
30
31
|
*
|
|
31
32
|
* @browserapi navigator.geolocation https://developer.mozilla.org/en-US/docs/Web/API/Navigator/geolocation
|
|
32
33
|
*
|
|
@@ -4,6 +4,7 @@ type UseHashReturn = [string, (value: string) => void];
|
|
|
4
4
|
* @name useHash
|
|
5
5
|
* @description - Hook that manages the hash value
|
|
6
6
|
* @category State
|
|
7
|
+
* @usage low
|
|
7
8
|
*
|
|
8
9
|
* @param {string} [initialValue] The initial hash value if no hash exists
|
|
9
10
|
* @returns {UseHashReturn} An array containing the hash value and a function to set the hash value
|
|
@@ -2,6 +2,8 @@ import { HookTarget } from '../../utils/helpers';
|
|
|
2
2
|
import { StateRef } from '../useRefState/useRefState';
|
|
3
3
|
/** The use hover options type */
|
|
4
4
|
export interface UseHoverOptions {
|
|
5
|
+
/** The enabled state of the hook */
|
|
6
|
+
enabled?: boolean;
|
|
5
7
|
/** The on entry callback */
|
|
6
8
|
onEntry?: (event: Event) => void;
|
|
7
9
|
/** The on leave callback */
|
|
@@ -24,6 +26,7 @@ export interface UseHover {
|
|
|
24
26
|
* @name useHover
|
|
25
27
|
* @description - Hook that defines the logic when hovering an element
|
|
26
28
|
* @category Elements
|
|
29
|
+
* @usage medium
|
|
27
30
|
*
|
|
28
31
|
* @overload
|
|
29
32
|
* @param {HookTarget} target The target element to be hovered
|
|
@@ -16,6 +16,7 @@ export interface UseIdleReturn {
|
|
|
16
16
|
* @name useIdle
|
|
17
17
|
* @description - Hook that defines the logic when the user is idle
|
|
18
18
|
* @category Sensors
|
|
19
|
+
* @usage low
|
|
19
20
|
*
|
|
20
21
|
* @param {number} [milliseconds=ONE_MINUTE] The idle time in milliseconds
|
|
21
22
|
* @param {boolean} [options.initialState=false] The options for the hook
|
|
@@ -22,6 +22,7 @@ export type UseImageReturn = UseQueryReturn<HTMLImageElement>;
|
|
|
22
22
|
* @name useImage
|
|
23
23
|
* @description - Hook that load an image in the browser
|
|
24
24
|
* @category Elements
|
|
25
|
+
* @usage low
|
|
25
26
|
*
|
|
26
27
|
* @param {string} src The source of the image
|
|
27
28
|
* @param {string} [options.srcset] The srcset of the image
|
|
@@ -1,16 +1,24 @@
|
|
|
1
1
|
import { HookTarget } from '../../utils/helpers';
|
|
2
2
|
import { StateRef } from '../useRefState/useRefState';
|
|
3
|
-
|
|
3
|
+
/** The intersection observer callback type */
|
|
4
|
+
export type UseIntersectionObserverCallback = (entry: IntersectionObserverEntry, observer: IntersectionObserver) => void;
|
|
4
5
|
/** The intersection observer options type */
|
|
5
6
|
export interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
|
|
7
|
+
/** The enabled state of the intersection observer */
|
|
6
8
|
enabled?: boolean;
|
|
9
|
+
/** The callback to execute when intersection is detected */
|
|
7
10
|
onChange?: UseIntersectionObserverCallback;
|
|
11
|
+
/** The root element to observe */
|
|
8
12
|
root?: HookTarget;
|
|
9
13
|
}
|
|
10
14
|
/** The intersection observer return type */
|
|
11
15
|
export interface UseIntersectionObserverReturn {
|
|
16
|
+
/** The intersection observer entry */
|
|
12
17
|
entry?: IntersectionObserverEntry;
|
|
18
|
+
/** The in view state of the intersection observer */
|
|
13
19
|
inView: boolean;
|
|
20
|
+
/** The intersection observer instance */
|
|
21
|
+
observer?: IntersectionObserver;
|
|
14
22
|
}
|
|
15
23
|
export interface UseIntersectionObserver {
|
|
16
24
|
<Target extends Element>(options?: UseIntersectionObserverOptions, target?: never): UseIntersectionObserverReturn & {
|
|
@@ -20,12 +28,13 @@ export interface UseIntersectionObserver {
|
|
|
20
28
|
<Target extends Element>(callback: UseIntersectionObserverCallback, target?: never): UseIntersectionObserverReturn & {
|
|
21
29
|
ref: StateRef<Target>;
|
|
22
30
|
};
|
|
23
|
-
(
|
|
31
|
+
(target: HookTarget, callback: UseIntersectionObserverCallback): UseIntersectionObserverReturn;
|
|
24
32
|
}
|
|
25
33
|
/**
|
|
26
34
|
* @name useIntersectionObserver
|
|
27
35
|
* @description - Hook that gives you intersection observer state
|
|
28
36
|
* @category Sensors
|
|
37
|
+
* @usage medium
|
|
29
38
|
*
|
|
30
39
|
* @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver
|
|
31
40
|
*
|
|
@@ -37,7 +46,7 @@ export interface UseIntersectionObserver {
|
|
|
37
46
|
* @returns {UseIntersectionObserverReturn} An object containing the state
|
|
38
47
|
*
|
|
39
48
|
* @example
|
|
40
|
-
* const { ref, entry, inView } = useIntersectionObserver();
|
|
49
|
+
* const { ref, entry, inView, observer } = useIntersectionObserver();
|
|
41
50
|
*
|
|
42
51
|
* @overload
|
|
43
52
|
* @template Target The target element
|
|
@@ -47,7 +56,7 @@ export interface UseIntersectionObserver {
|
|
|
47
56
|
* @returns {UseIntersectionObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
|
|
48
57
|
*
|
|
49
58
|
* @example
|
|
50
|
-
* const { entry, inView } = useIntersectionObserver(ref);
|
|
59
|
+
* const { entry, inView, observer } = useIntersectionObserver(ref);
|
|
51
60
|
*
|
|
52
61
|
* @overload
|
|
53
62
|
* @template Target The target element
|
|
@@ -55,7 +64,7 @@ export interface UseIntersectionObserver {
|
|
|
55
64
|
* @returns {UseIntersectionObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
|
|
56
65
|
*
|
|
57
66
|
* @example
|
|
58
|
-
* const { ref, entry, inView } = useIntersectionObserver(() => console.log('callback'));
|
|
67
|
+
* const { ref, entry, inView, observer } = useIntersectionObserver(() => console.log('callback'));
|
|
59
68
|
*
|
|
60
69
|
* @overload
|
|
61
70
|
* @param {UseIntersectionObserverCallback} callback The callback to execute when intersection is detected
|
|
@@ -63,6 +72,6 @@ export interface UseIntersectionObserver {
|
|
|
63
72
|
* @returns {UseIntersectionObserverReturn} An object containing the state
|
|
64
73
|
*
|
|
65
74
|
* @example
|
|
66
|
-
* const { entry, inView } = useIntersectionObserver(() => console.log('callback'), ref);
|
|
75
|
+
* const { entry, inView, observer } = useIntersectionObserver(() => console.log('callback'), ref);
|
|
67
76
|
*/
|
|
68
77
|
export declare const useIntersectionObserver: UseIntersectionObserver;
|
|
@@ -3,6 +3,7 @@ import { useEffect } from 'react';
|
|
|
3
3
|
* @name useIsomorphicLayoutEffect
|
|
4
4
|
* @description - Hook conditionally selects either `useLayoutEffect` or `useEffect` based on the environment
|
|
5
5
|
* @category Lifecycle
|
|
6
|
+
* @usage high
|
|
6
7
|
*
|
|
7
8
|
* @example
|
|
8
9
|
* useIsomorphicLayoutEffect(() => console.log('effect'), [])
|
|
@@ -21,6 +21,7 @@ export interface UseKeyPressEvent {
|
|
|
21
21
|
* @name useKeyPressEvent
|
|
22
22
|
* @description - Hook that listens for key press events on specified targets
|
|
23
23
|
* @category Sensors
|
|
24
|
+
* @usage low
|
|
24
25
|
*
|
|
25
26
|
* @overload
|
|
26
27
|
* @param {UseKeyPressEventKey} key The key or array of keys to listen for.
|
|
@@ -19,11 +19,10 @@ export interface UseKeysPressed {
|
|
|
19
19
|
};
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* Hook that tracks which keyboard keys are currently pressed
|
|
23
|
-
*
|
|
24
22
|
* @name useKeysPressed
|
|
25
23
|
* @description Tracks all currently pressed keyboard keys and their codes
|
|
26
24
|
* @category Sensors
|
|
25
|
+
* @usage low
|
|
27
26
|
*
|
|
28
27
|
* @overload
|
|
29
28
|
* @param {HookTarget | Window} target DOM element or ref to attach keyboard listeners to
|
|
@@ -6,6 +6,7 @@ export interface UseLastChangedOptions {
|
|
|
6
6
|
* @name useLastChanged
|
|
7
7
|
* @description - Hook for records the timestamp of the last change
|
|
8
8
|
* @category Utilities
|
|
9
|
+
* @usage low
|
|
9
10
|
*
|
|
10
11
|
* @param {any} source The source of the last change
|
|
11
12
|
* @param {number | null} [options.initialValue=null] The initial value
|
|
@@ -7,6 +7,7 @@ export interface UseLatestReturn<Value> {
|
|
|
7
7
|
* @name useLatest
|
|
8
8
|
* @description - Hook that returns the stable reference of the value
|
|
9
9
|
* @category Utilities
|
|
10
|
+
* @usage medium
|
|
10
11
|
*
|
|
11
12
|
* @template Value The type of the value
|
|
12
13
|
* @param {Value} value The value to get the previous value
|