@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.
Files changed (540) hide show
  1. package/README.md +71 -71
  2. package/dist/cjs/helpers/createContext/createContext.cjs.map +1 -1
  3. package/dist/cjs/helpers/createEventEmitter/createEventEmitter.cjs.map +1 -1
  4. package/dist/cjs/helpers/createReactiveContext/createReactiveContext.cjs.map +1 -1
  5. package/dist/cjs/helpers/createStore/createStore.cjs.map +1 -1
  6. package/dist/cjs/hooks/useActiveElement/useActiveElement.cjs.map +1 -1
  7. package/dist/cjs/hooks/useAsync/useAsync.cjs.map +1 -1
  8. package/dist/cjs/hooks/useAudio/useAudio.cjs.map +1 -1
  9. package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs +1 -1
  10. package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs.map +1 -1
  11. package/dist/cjs/hooks/useBattery/useBattery.cjs +1 -1
  12. package/dist/cjs/hooks/useBattery/useBattery.cjs.map +1 -1
  13. package/dist/cjs/hooks/useBluetooth/useBluetooth.cjs +1 -1
  14. package/dist/cjs/hooks/useBluetooth/useBluetooth.cjs.map +1 -1
  15. package/dist/cjs/hooks/useBoolean/useBoolean.cjs.map +1 -1
  16. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.cjs.map +1 -1
  17. package/dist/cjs/hooks/useBroadcastChannel/useBroadcastChannel.cjs +1 -1
  18. package/dist/cjs/hooks/useBroadcastChannel/useBroadcastChannel.cjs.map +1 -1
  19. package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.cjs.map +1 -1
  20. package/dist/cjs/hooks/useClickOutside/useClickOutside.cjs.map +1 -1
  21. package/dist/cjs/hooks/useClipboard/useClipboard.cjs.map +1 -1
  22. package/dist/cjs/hooks/useConst/useConst.cjs.map +1 -1
  23. package/dist/cjs/hooks/useCookie/useCookie.cjs.map +1 -1
  24. package/dist/cjs/hooks/useCookies/useCookies.cjs.map +1 -1
  25. package/dist/cjs/hooks/useCopy/useCopy.cjs.map +1 -1
  26. package/dist/cjs/hooks/useCounter/useCounter.cjs.map +1 -1
  27. package/dist/cjs/hooks/useCssVar/useCssVar.cjs.map +1 -1
  28. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.cjs.map +1 -1
  29. package/dist/cjs/hooks/useDebounceState/useDebounceState.cjs +2 -0
  30. package/dist/cjs/hooks/useDebounceState/useDebounceState.cjs.map +1 -0
  31. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.cjs.map +1 -1
  32. package/dist/cjs/hooks/useDefault/useDefault.cjs.map +1 -1
  33. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.cjs.map +1 -1
  34. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.cjs +1 -1
  35. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.cjs.map +1 -1
  36. package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.cjs +1 -1
  37. package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.cjs.map +1 -1
  38. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.cjs.map +1 -1
  39. package/dist/cjs/hooks/useDisclosure/useDisclosure.cjs.map +1 -1
  40. package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.cjs.map +1 -1
  41. package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.cjs.map +1 -1
  42. package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.cjs.map +1 -1
  43. package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.cjs.map +1 -1
  44. package/dist/cjs/hooks/useDoubleClick/useDoubleClick.cjs.map +1 -1
  45. package/dist/cjs/hooks/useDropZone/useDropZone.cjs +1 -1
  46. package/dist/cjs/hooks/useDropZone/useDropZone.cjs.map +1 -1
  47. package/dist/cjs/hooks/useElementSize/useElementSize.cjs.map +1 -1
  48. package/dist/cjs/hooks/useEvent/useEvent.cjs.map +1 -1
  49. package/dist/cjs/hooks/useEventListener/useEventListener.cjs +1 -1
  50. package/dist/cjs/hooks/useEventListener/useEventListener.cjs.map +1 -1
  51. package/dist/cjs/hooks/useEventSource/useEventSource.cjs.map +1 -1
  52. package/dist/cjs/hooks/useEyeDropper/useEyeDropper.cjs +1 -1
  53. package/dist/cjs/hooks/useEyeDropper/useEyeDropper.cjs.map +1 -1
  54. package/dist/cjs/hooks/useFavicon/useFavicon.cjs +1 -1
  55. package/dist/cjs/hooks/useFavicon/useFavicon.cjs.map +1 -1
  56. package/dist/cjs/hooks/useField/useField.cjs.map +1 -1
  57. package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs +1 -1
  58. package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs.map +1 -1
  59. package/dist/cjs/hooks/useFocus/useFocus.cjs +1 -1
  60. package/dist/cjs/hooks/useFocus/useFocus.cjs.map +1 -1
  61. package/dist/cjs/hooks/useFps/useFps.cjs.map +1 -1
  62. package/dist/cjs/hooks/useFul/useFul.cjs.map +1 -1
  63. package/dist/cjs/hooks/useFullscreen/useFullscreen.cjs.map +1 -1
  64. package/dist/cjs/hooks/useGamepad/useGamepad.cjs +1 -1
  65. package/dist/cjs/hooks/useGamepad/useGamepad.cjs.map +1 -1
  66. package/dist/cjs/hooks/useGeolocation/useGeolocation.cjs.map +1 -1
  67. package/dist/cjs/hooks/useHash/useHash.cjs.map +1 -1
  68. package/dist/cjs/hooks/useHotkeys/useHotkeys.cjs.map +1 -1
  69. package/dist/cjs/hooks/useHover/useHover.cjs +1 -1
  70. package/dist/cjs/hooks/useHover/useHover.cjs.map +1 -1
  71. package/dist/cjs/hooks/useIdle/useIdle.cjs.map +1 -1
  72. package/dist/cjs/hooks/useImage/useImage.cjs.map +1 -1
  73. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.cjs.map +1 -1
  74. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs +1 -1
  75. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs.map +1 -1
  76. package/dist/cjs/hooks/useInterval/useInterval.cjs.map +1 -1
  77. package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.cjs.map +1 -1
  78. package/dist/cjs/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.cjs.map +1 -1
  79. package/dist/cjs/hooks/useKeyPress/useKeyPress.cjs.map +1 -1
  80. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.cjs.map +1 -1
  81. package/dist/cjs/hooks/useKeyboard/useKeyboard.cjs.map +1 -1
  82. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.cjs.map +1 -1
  83. package/dist/cjs/hooks/useLastChanged/useLastChanged.cjs.map +1 -1
  84. package/dist/cjs/hooks/useLatest/useLatest.cjs.map +1 -1
  85. package/dist/cjs/hooks/useLess/useLess.cjs.map +1 -1
  86. package/dist/cjs/hooks/useList/useList.cjs.map +1 -1
  87. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.cjs.map +1 -1
  88. package/dist/cjs/hooks/useLockCallback/useLockCallback.cjs.map +1 -1
  89. package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs +1 -1
  90. package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs.map +1 -1
  91. package/dist/cjs/hooks/useLogger/useLogger.cjs.map +1 -1
  92. package/dist/cjs/hooks/useLongPress/useLongPress.cjs.map +1 -1
  93. package/dist/cjs/hooks/useMap/useMap.cjs.map +1 -1
  94. package/dist/cjs/hooks/useMeasure/useMeasure.cjs.map +1 -1
  95. package/dist/cjs/hooks/useMediaControls/useMediaControls.cjs.map +1 -1
  96. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.cjs.map +1 -1
  97. package/dist/cjs/hooks/useMemory/useMemory.cjs +1 -1
  98. package/dist/cjs/hooks/useMemory/useMemory.cjs.map +1 -1
  99. package/dist/cjs/hooks/useMergedRef/useMergedRef.cjs +2 -0
  100. package/dist/cjs/hooks/useMergedRef/useMergedRef.cjs.map +1 -0
  101. package/dist/cjs/hooks/useMount/useMount.cjs.map +1 -1
  102. package/dist/cjs/hooks/useMouse/useMouse.cjs.map +1 -1
  103. package/dist/cjs/hooks/useMutation/useMutation.cjs +1 -1
  104. package/dist/cjs/hooks/useMutation/useMutation.cjs.map +1 -1
  105. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs +1 -1
  106. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs.map +1 -1
  107. package/dist/cjs/hooks/useNetwork/useNetwork.cjs.map +1 -1
  108. package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.cjs.map +1 -1
  109. package/dist/cjs/hooks/useOnce/useOnce.cjs.map +1 -1
  110. package/dist/cjs/hooks/useOnline/useOnline.cjs.map +1 -1
  111. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.cjs.map +1 -1
  112. package/dist/cjs/hooks/useOptimistic/useOptimistic.cjs.map +1 -1
  113. package/dist/cjs/hooks/useOrientation/useOrientation.cjs +1 -1
  114. package/dist/cjs/hooks/useOrientation/useOrientation.cjs.map +1 -1
  115. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs +1 -1
  116. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs.map +1 -1
  117. package/dist/cjs/hooks/usePageLeave/usePageLeave.cjs.map +1 -1
  118. package/dist/cjs/hooks/usePaint/usePaint.cjs.map +1 -1
  119. package/dist/cjs/hooks/useParallax/useParallax.cjs.map +1 -1
  120. package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.cjs +1 -1
  121. package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.cjs.map +1 -1
  122. package/dist/cjs/hooks/usePermission/usePermission.cjs +1 -1
  123. package/dist/cjs/hooks/usePermission/usePermission.cjs.map +1 -1
  124. package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs +1 -1
  125. package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs.map +1 -1
  126. package/dist/cjs/hooks/usePointerLock/usePointerLock.cjs +1 -1
  127. package/dist/cjs/hooks/usePointerLock/usePointerLock.cjs.map +1 -1
  128. package/dist/cjs/hooks/usePostMessage/usePostMessage.cjs.map +1 -1
  129. package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.cjs.map +1 -1
  130. package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.cjs.map +1 -1
  131. package/dist/cjs/hooks/usePreferredDark/usePreferredDark.cjs.map +1 -1
  132. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.cjs.map +1 -1
  133. package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.cjs.map +1 -1
  134. package/dist/cjs/hooks/usePrevious/usePrevious.cjs.map +1 -1
  135. package/dist/cjs/hooks/useQuery/useQuery.cjs.map +1 -1
  136. package/dist/cjs/hooks/useQueue/useQueue.cjs.map +1 -1
  137. package/dist/cjs/hooks/useRaf/useRaf.cjs.map +1 -1
  138. package/dist/cjs/hooks/useRafState/useRafState.cjs.map +1 -1
  139. package/dist/cjs/hooks/useRefState/useRefState.cjs.map +1 -1
  140. package/dist/cjs/hooks/useRenderCount/useRenderCount.cjs.map +1 -1
  141. package/dist/cjs/hooks/useRenderInfo/useRenderInfo.cjs.map +1 -1
  142. package/dist/cjs/hooks/useRerender/useRerender.cjs.map +1 -1
  143. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs +1 -1
  144. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs.map +1 -1
  145. package/dist/cjs/hooks/useRightClick/useRightClick.cjs.map +1 -1
  146. package/dist/cjs/hooks/useScript/useScript.cjs.map +1 -1
  147. package/dist/cjs/hooks/useScroll/useScroll.cjs +1 -1
  148. package/dist/cjs/hooks/useScroll/useScroll.cjs.map +1 -1
  149. package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs +1 -1
  150. package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs.map +1 -1
  151. package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs +1 -1
  152. package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs.map +1 -1
  153. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.cjs.map +1 -1
  154. package/dist/cjs/hooks/useSet/useSet.cjs.map +1 -1
  155. package/dist/cjs/hooks/useShallowEffect/useShallowEffect.cjs.map +1 -1
  156. package/dist/cjs/hooks/useShare/useShare.cjs +1 -1
  157. package/dist/cjs/hooks/useShare/useShare.cjs.map +1 -1
  158. package/dist/cjs/hooks/useSpeechRecognition/useSpeechRecognition.cjs.map +1 -1
  159. package/dist/cjs/hooks/useSpeechSynthesis/useSpeechSynthesis.cjs +1 -1
  160. package/dist/cjs/hooks/useSpeechSynthesis/useSpeechSynthesis.cjs.map +1 -1
  161. package/dist/cjs/hooks/useStateHistory/useStateHistory.cjs.map +1 -1
  162. package/dist/cjs/hooks/useStep/useStep.cjs.map +1 -1
  163. package/dist/cjs/hooks/useSticky/useSticky.cjs.map +1 -1
  164. package/dist/cjs/hooks/useStopwatch/useStopwatch.cjs.map +1 -1
  165. package/dist/cjs/hooks/useStorage/useStorage.cjs.map +1 -1
  166. package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs +1 -1
  167. package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs.map +1 -1
  168. package/dist/cjs/hooks/useTextSelection/useTextSelection.cjs.map +1 -1
  169. package/dist/cjs/hooks/useThrottleCallback/useThrottleCallback.cjs.map +1 -1
  170. package/dist/cjs/hooks/useThrottleState/useThrottleState.cjs +2 -0
  171. package/dist/cjs/hooks/useThrottleState/useThrottleState.cjs.map +1 -0
  172. package/dist/cjs/hooks/useThrottleValue/useThrottleValue.cjs.map +1 -1
  173. package/dist/cjs/hooks/useTime/useTime.cjs.map +1 -1
  174. package/dist/cjs/hooks/useTimeout/useTimeout.cjs.map +1 -1
  175. package/dist/cjs/hooks/useTimer/useTimer.cjs.map +1 -1
  176. package/dist/cjs/hooks/useToggle/useToggle.cjs.map +1 -1
  177. package/dist/cjs/hooks/useUnmount/useUnmount.cjs.map +1 -1
  178. package/dist/cjs/hooks/useUrlSearchParam/useUrlSearchParam.cjs.map +1 -1
  179. package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs.map +1 -1
  180. package/dist/cjs/hooks/useVibrate/useVibrate.cjs +1 -1
  181. package/dist/cjs/hooks/useVibrate/useVibrate.cjs.map +1 -1
  182. package/dist/cjs/hooks/useVirtualKeyboard/useVirtualKeyboard.cjs +1 -1
  183. package/dist/cjs/hooks/useVirtualKeyboard/useVirtualKeyboard.cjs.map +1 -1
  184. package/dist/cjs/hooks/useWakeLock/useWakeLock.cjs +1 -1
  185. package/dist/cjs/hooks/useWakeLock/useWakeLock.cjs.map +1 -1
  186. package/dist/cjs/hooks/useWebSocket/useWebSocket.cjs.map +1 -1
  187. package/dist/cjs/hooks/useWindowEvent/useWindowEvent.cjs.map +1 -1
  188. package/dist/cjs/hooks/useWindowFocus/useWindowFocus.cjs.map +1 -1
  189. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.cjs.map +1 -1
  190. package/dist/cjs/hooks/useWindowSize/useWindowSize.cjs.map +1 -1
  191. package/dist/cjs/hooks/useWizard/useWizard.cjs.map +1 -1
  192. package/dist/cjs/index.cjs +1 -1
  193. package/dist/esm/helpers/createContext/createContext.mjs.map +1 -1
  194. package/dist/esm/helpers/createEventEmitter/createEventEmitter.mjs.map +1 -1
  195. package/dist/esm/helpers/createReactiveContext/createReactiveContext.mjs.map +1 -1
  196. package/dist/esm/helpers/createStore/createStore.mjs.map +1 -1
  197. package/dist/esm/hooks/useActiveElement/useActiveElement.mjs.map +1 -1
  198. package/dist/esm/hooks/useAsync/useAsync.mjs.map +1 -1
  199. package/dist/esm/hooks/useAudio/useAudio.mjs.map +1 -1
  200. package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs +25 -31
  201. package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs.map +1 -1
  202. package/dist/esm/hooks/useBattery/useBattery.mjs +1 -1
  203. package/dist/esm/hooks/useBattery/useBattery.mjs.map +1 -1
  204. package/dist/esm/hooks/useBluetooth/useBluetooth.mjs +16 -18
  205. package/dist/esm/hooks/useBluetooth/useBluetooth.mjs.map +1 -1
  206. package/dist/esm/hooks/useBoolean/useBoolean.mjs.map +1 -1
  207. package/dist/esm/hooks/useBreakpoints/useBreakpoints.mjs.map +1 -1
  208. package/dist/esm/hooks/useBroadcastChannel/useBroadcastChannel.mjs +8 -8
  209. package/dist/esm/hooks/useBroadcastChannel/useBroadcastChannel.mjs.map +1 -1
  210. package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.mjs.map +1 -1
  211. package/dist/esm/hooks/useClickOutside/useClickOutside.mjs.map +1 -1
  212. package/dist/esm/hooks/useClipboard/useClipboard.mjs.map +1 -1
  213. package/dist/esm/hooks/useConst/useConst.mjs.map +1 -1
  214. package/dist/esm/hooks/useCookie/useCookie.mjs.map +1 -1
  215. package/dist/esm/hooks/useCookies/useCookies.mjs.map +1 -1
  216. package/dist/esm/hooks/useCopy/useCopy.mjs.map +1 -1
  217. package/dist/esm/hooks/useCounter/useCounter.mjs.map +1 -1
  218. package/dist/esm/hooks/useCssVar/useCssVar.mjs.map +1 -1
  219. package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.mjs.map +1 -1
  220. package/dist/esm/hooks/useDebounceState/useDebounceState.mjs +10 -0
  221. package/dist/esm/hooks/useDebounceState/useDebounceState.mjs.map +1 -0
  222. package/dist/esm/hooks/useDebounceValue/useDebounceValue.mjs.map +1 -1
  223. package/dist/esm/hooks/useDefault/useDefault.mjs.map +1 -1
  224. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.mjs.map +1 -1
  225. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.mjs +1 -1
  226. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.mjs.map +1 -1
  227. package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.mjs +1 -1
  228. package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.mjs.map +1 -1
  229. package/dist/esm/hooks/useDidUpdate/useDidUpdate.mjs.map +1 -1
  230. package/dist/esm/hooks/useDisclosure/useDisclosure.mjs.map +1 -1
  231. package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.mjs.map +1 -1
  232. package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.mjs.map +1 -1
  233. package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.mjs.map +1 -1
  234. package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.mjs.map +1 -1
  235. package/dist/esm/hooks/useDoubleClick/useDoubleClick.mjs.map +1 -1
  236. package/dist/esm/hooks/useDropZone/useDropZone.mjs +12 -12
  237. package/dist/esm/hooks/useDropZone/useDropZone.mjs.map +1 -1
  238. package/dist/esm/hooks/useElementSize/useElementSize.mjs.map +1 -1
  239. package/dist/esm/hooks/useEvent/useEvent.mjs.map +1 -1
  240. package/dist/esm/hooks/useEventListener/useEventListener.mjs +15 -15
  241. package/dist/esm/hooks/useEventListener/useEventListener.mjs.map +1 -1
  242. package/dist/esm/hooks/useEventSource/useEventSource.mjs.map +1 -1
  243. package/dist/esm/hooks/useEyeDropper/useEyeDropper.mjs +3 -3
  244. package/dist/esm/hooks/useEyeDropper/useEyeDropper.mjs.map +1 -1
  245. package/dist/esm/hooks/useFavicon/useFavicon.mjs +12 -15
  246. package/dist/esm/hooks/useFavicon/useFavicon.mjs.map +1 -1
  247. package/dist/esm/hooks/useField/useField.mjs.map +1 -1
  248. package/dist/esm/hooks/useFileDialog/useFileDialog.mjs +13 -13
  249. package/dist/esm/hooks/useFileDialog/useFileDialog.mjs.map +1 -1
  250. package/dist/esm/hooks/useFocus/useFocus.mjs +26 -22
  251. package/dist/esm/hooks/useFocus/useFocus.mjs.map +1 -1
  252. package/dist/esm/hooks/useFps/useFps.mjs.map +1 -1
  253. package/dist/esm/hooks/useFul/useFul.mjs.map +1 -1
  254. package/dist/esm/hooks/useFullscreen/useFullscreen.mjs.map +1 -1
  255. package/dist/esm/hooks/useGamepad/useGamepad.mjs +13 -13
  256. package/dist/esm/hooks/useGamepad/useGamepad.mjs.map +1 -1
  257. package/dist/esm/hooks/useGeolocation/useGeolocation.mjs.map +1 -1
  258. package/dist/esm/hooks/useHash/useHash.mjs.map +1 -1
  259. package/dist/esm/hooks/useHotkeys/useHotkeys.mjs.map +1 -1
  260. package/dist/esm/hooks/useHover/useHover.mjs +15 -15
  261. package/dist/esm/hooks/useHover/useHover.mjs.map +1 -1
  262. package/dist/esm/hooks/useIdle/useIdle.mjs.map +1 -1
  263. package/dist/esm/hooks/useImage/useImage.mjs.map +1 -1
  264. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.mjs.map +1 -1
  265. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs +19 -18
  266. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs.map +1 -1
  267. package/dist/esm/hooks/useInterval/useInterval.mjs.map +1 -1
  268. package/dist/esm/hooks/useIsFirstRender/useIsFirstRender.mjs.map +1 -1
  269. package/dist/esm/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs.map +1 -1
  270. package/dist/esm/hooks/useKeyPress/useKeyPress.mjs.map +1 -1
  271. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.mjs.map +1 -1
  272. package/dist/esm/hooks/useKeyboard/useKeyboard.mjs.map +1 -1
  273. package/dist/esm/hooks/useKeysPressed/useKeysPressed.mjs.map +1 -1
  274. package/dist/esm/hooks/useLastChanged/useLastChanged.mjs.map +1 -1
  275. package/dist/esm/hooks/useLatest/useLatest.mjs.map +1 -1
  276. package/dist/esm/hooks/useLess/useLess.mjs.map +1 -1
  277. package/dist/esm/hooks/useList/useList.mjs.map +1 -1
  278. package/dist/esm/hooks/useLocalStorage/useLocalStorage.mjs.map +1 -1
  279. package/dist/esm/hooks/useLockCallback/useLockCallback.mjs.map +1 -1
  280. package/dist/esm/hooks/useLockScroll/useLockScroll.mjs +24 -24
  281. package/dist/esm/hooks/useLockScroll/useLockScroll.mjs.map +1 -1
  282. package/dist/esm/hooks/useLogger/useLogger.mjs.map +1 -1
  283. package/dist/esm/hooks/useLongPress/useLongPress.mjs.map +1 -1
  284. package/dist/esm/hooks/useMap/useMap.mjs.map +1 -1
  285. package/dist/esm/hooks/useMeasure/useMeasure.mjs.map +1 -1
  286. package/dist/esm/hooks/useMediaControls/useMediaControls.mjs.map +1 -1
  287. package/dist/esm/hooks/useMediaQuery/useMediaQuery.mjs.map +1 -1
  288. package/dist/esm/hooks/useMemory/useMemory.mjs +4 -4
  289. package/dist/esm/hooks/useMemory/useMemory.mjs.map +1 -1
  290. package/dist/esm/hooks/useMergedRef/useMergedRef.mjs +25 -0
  291. package/dist/esm/hooks/useMergedRef/useMergedRef.mjs.map +1 -0
  292. package/dist/esm/hooks/useMount/useMount.mjs.map +1 -1
  293. package/dist/esm/hooks/useMouse/useMouse.mjs.map +1 -1
  294. package/dist/esm/hooks/useMutation/useMutation.mjs +18 -18
  295. package/dist/esm/hooks/useMutation/useMutation.mjs.map +1 -1
  296. package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs +28 -20
  297. package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs.map +1 -1
  298. package/dist/esm/hooks/useNetwork/useNetwork.mjs.map +1 -1
  299. package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.mjs.map +1 -1
  300. package/dist/esm/hooks/useOnce/useOnce.mjs.map +1 -1
  301. package/dist/esm/hooks/useOnline/useOnline.mjs.map +1 -1
  302. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.mjs.map +1 -1
  303. package/dist/esm/hooks/useOptimistic/useOptimistic.mjs.map +1 -1
  304. package/dist/esm/hooks/useOrientation/useOrientation.mjs +9 -9
  305. package/dist/esm/hooks/useOrientation/useOrientation.mjs.map +1 -1
  306. package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs +3 -3
  307. package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs.map +1 -1
  308. package/dist/esm/hooks/usePageLeave/usePageLeave.mjs.map +1 -1
  309. package/dist/esm/hooks/usePaint/usePaint.mjs.map +1 -1
  310. package/dist/esm/hooks/useParallax/useParallax.mjs.map +1 -1
  311. package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.mjs +11 -11
  312. package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.mjs.map +1 -1
  313. package/dist/esm/hooks/usePermission/usePermission.mjs +4 -4
  314. package/dist/esm/hooks/usePermission/usePermission.mjs.map +1 -1
  315. package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs +17 -17
  316. package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs.map +1 -1
  317. package/dist/esm/hooks/usePointerLock/usePointerLock.mjs +3 -3
  318. package/dist/esm/hooks/usePointerLock/usePointerLock.mjs.map +1 -1
  319. package/dist/esm/hooks/usePostMessage/usePostMessage.mjs.map +1 -1
  320. package/dist/esm/hooks/usePreferredColorScheme/usePreferredColorScheme.mjs.map +1 -1
  321. package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.mjs.map +1 -1
  322. package/dist/esm/hooks/usePreferredDark/usePreferredDark.mjs.map +1 -1
  323. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.mjs.map +1 -1
  324. package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.mjs.map +1 -1
  325. package/dist/esm/hooks/usePrevious/usePrevious.mjs.map +1 -1
  326. package/dist/esm/hooks/useQuery/useQuery.mjs.map +1 -1
  327. package/dist/esm/hooks/useQueue/useQueue.mjs.map +1 -1
  328. package/dist/esm/hooks/useRaf/useRaf.mjs.map +1 -1
  329. package/dist/esm/hooks/useRafState/useRafState.mjs.map +1 -1
  330. package/dist/esm/hooks/useRefState/useRefState.mjs.map +1 -1
  331. package/dist/esm/hooks/useRenderCount/useRenderCount.mjs.map +1 -1
  332. package/dist/esm/hooks/useRenderInfo/useRenderInfo.mjs.map +1 -1
  333. package/dist/esm/hooks/useRerender/useRerender.mjs.map +1 -1
  334. package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs +17 -16
  335. package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs.map +1 -1
  336. package/dist/esm/hooks/useRightClick/useRightClick.mjs.map +1 -1
  337. package/dist/esm/hooks/useScript/useScript.mjs.map +1 -1
  338. package/dist/esm/hooks/useScroll/useScroll.mjs +11 -13
  339. package/dist/esm/hooks/useScroll/useScroll.mjs.map +1 -1
  340. package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs +27 -27
  341. package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs.map +1 -1
  342. package/dist/esm/hooks/useScrollTo/useScrollTo.mjs +16 -16
  343. package/dist/esm/hooks/useScrollTo/useScrollTo.mjs.map +1 -1
  344. package/dist/esm/hooks/useSessionStorage/useSessionStorage.mjs.map +1 -1
  345. package/dist/esm/hooks/useSet/useSet.mjs.map +1 -1
  346. package/dist/esm/hooks/useShallowEffect/useShallowEffect.mjs.map +1 -1
  347. package/dist/esm/hooks/useShare/useShare.mjs +1 -1
  348. package/dist/esm/hooks/useShare/useShare.mjs.map +1 -1
  349. package/dist/esm/hooks/useSpeechRecognition/useSpeechRecognition.mjs.map +1 -1
  350. package/dist/esm/hooks/useSpeechSynthesis/useSpeechSynthesis.mjs +11 -11
  351. package/dist/esm/hooks/useSpeechSynthesis/useSpeechSynthesis.mjs.map +1 -1
  352. package/dist/esm/hooks/useStateHistory/useStateHistory.mjs.map +1 -1
  353. package/dist/esm/hooks/useStep/useStep.mjs.map +1 -1
  354. package/dist/esm/hooks/useSticky/useSticky.mjs.map +1 -1
  355. package/dist/esm/hooks/useStopwatch/useStopwatch.mjs.map +1 -1
  356. package/dist/esm/hooks/useStorage/useStorage.mjs.map +1 -1
  357. package/dist/esm/hooks/useTextDirection/useTextDirection.mjs +14 -14
  358. package/dist/esm/hooks/useTextDirection/useTextDirection.mjs.map +1 -1
  359. package/dist/esm/hooks/useTextSelection/useTextSelection.mjs.map +1 -1
  360. package/dist/esm/hooks/useThrottleCallback/useThrottleCallback.mjs.map +1 -1
  361. package/dist/esm/hooks/useThrottleState/useThrottleState.mjs +10 -0
  362. package/dist/esm/hooks/useThrottleState/useThrottleState.mjs.map +1 -0
  363. package/dist/esm/hooks/useThrottleValue/useThrottleValue.mjs.map +1 -1
  364. package/dist/esm/hooks/useTime/useTime.mjs.map +1 -1
  365. package/dist/esm/hooks/useTimeout/useTimeout.mjs.map +1 -1
  366. package/dist/esm/hooks/useTimer/useTimer.mjs.map +1 -1
  367. package/dist/esm/hooks/useToggle/useToggle.mjs.map +1 -1
  368. package/dist/esm/hooks/useUnmount/useUnmount.mjs.map +1 -1
  369. package/dist/esm/hooks/useUrlSearchParam/useUrlSearchParam.mjs.map +1 -1
  370. package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs.map +1 -1
  371. package/dist/esm/hooks/useVibrate/useVibrate.mjs +12 -12
  372. package/dist/esm/hooks/useVibrate/useVibrate.mjs.map +1 -1
  373. package/dist/esm/hooks/useVirtualKeyboard/useVirtualKeyboard.mjs +7 -7
  374. package/dist/esm/hooks/useVirtualKeyboard/useVirtualKeyboard.mjs.map +1 -1
  375. package/dist/esm/hooks/useWakeLock/useWakeLock.mjs +1 -1
  376. package/dist/esm/hooks/useWakeLock/useWakeLock.mjs.map +1 -1
  377. package/dist/esm/hooks/useWebSocket/useWebSocket.mjs.map +1 -1
  378. package/dist/esm/hooks/useWindowEvent/useWindowEvent.mjs.map +1 -1
  379. package/dist/esm/hooks/useWindowFocus/useWindowFocus.mjs.map +1 -1
  380. package/dist/esm/hooks/useWindowScroll/useWindowScroll.mjs.map +1 -1
  381. package/dist/esm/hooks/useWindowSize/useWindowSize.mjs.map +1 -1
  382. package/dist/esm/hooks/useWizard/useWizard.mjs.map +1 -1
  383. package/dist/esm/index.mjs +147 -139
  384. package/dist/esm/index.mjs.map +1 -1
  385. package/dist/types/helpers/createContext/createContext.d.ts +1 -0
  386. package/dist/types/helpers/createEventEmitter/createEventEmitter.d.ts +1 -0
  387. package/dist/types/helpers/createReactiveContext/createReactiveContext.d.ts +1 -0
  388. package/dist/types/helpers/createStore/createStore.d.ts +1 -0
  389. package/dist/types/hooks/state.d.ts +1 -0
  390. package/dist/types/hooks/useActiveElement/useActiveElement.d.ts +1 -0
  391. package/dist/types/hooks/useAsync/useAsync.d.ts +1 -0
  392. package/dist/types/hooks/useAudio/useAudio.d.ts +2 -1
  393. package/dist/types/hooks/useAutoScroll/useAutoScroll.d.ts +1 -0
  394. package/dist/types/hooks/useBattery/useBattery.d.ts +1 -0
  395. package/dist/types/hooks/useBluetooth/useBluetooth.d.ts +1 -0
  396. package/dist/types/hooks/useBoolean/useBoolean.d.ts +2 -1
  397. package/dist/types/hooks/useBreakpoints/useBreakpoints.d.ts +1 -0
  398. package/dist/types/hooks/useBroadcastChannel/useBroadcastChannel.d.ts +1 -0
  399. package/dist/types/hooks/useBrowserLanguage/useBrowserLanguage.d.ts +2 -1
  400. package/dist/types/hooks/useClickOutside/useClickOutside.d.ts +2 -1
  401. package/dist/types/hooks/useClipboard/useClipboard.d.ts +2 -1
  402. package/dist/types/hooks/useConst/useConst.d.ts +2 -1
  403. package/dist/types/hooks/useCookie/useCookie.d.ts +2 -1
  404. package/dist/types/hooks/useCookies/useCookies.d.ts +2 -1
  405. package/dist/types/hooks/useCopy/useCopy.d.ts +2 -1
  406. package/dist/types/hooks/useCounter/useCounter.d.ts +2 -1
  407. package/dist/types/hooks/useCssVar/useCssVar.d.ts +2 -1
  408. package/dist/types/hooks/useDebounceCallback/useDebounceCallback.d.ts +1 -0
  409. package/dist/types/hooks/useDebounceState/useDebounceState.d.ts +15 -0
  410. package/dist/types/hooks/useDebounceValue/useDebounceValue.d.ts +2 -1
  411. package/dist/types/hooks/useDefault/useDefault.d.ts +2 -1
  412. package/dist/types/hooks/useDeviceMotion/useDeviceMotion.d.ts +2 -1
  413. package/dist/types/hooks/useDeviceOrientation/useDeviceOrientation.d.ts +1 -0
  414. package/dist/types/hooks/useDevicePixelRatio/useDevicePixelRatio.d.ts +1 -0
  415. package/dist/types/hooks/useDidUpdate/useDidUpdate.d.ts +2 -1
  416. package/dist/types/hooks/useDisclosure/useDisclosure.d.ts +2 -1
  417. package/dist/types/hooks/useDisplayMedia/useDisplayMedia.d.ts +1 -0
  418. package/dist/types/hooks/useDocumentEvent/useDocumentEvent.d.ts +2 -1
  419. package/dist/types/hooks/useDocumentTitle/useDocumentTitle.d.ts +2 -1
  420. package/dist/types/hooks/useDocumentVisibility/useDocumentVisibility.d.ts +2 -1
  421. package/dist/types/hooks/useDoubleClick/useDoubleClick.d.ts +2 -1
  422. package/dist/types/hooks/useDropZone/useDropZone.d.ts +2 -1
  423. package/dist/types/hooks/useElementSize/useElementSize.d.ts +2 -1
  424. package/dist/types/hooks/useEvent/useEvent.d.ts +2 -1
  425. package/dist/types/hooks/useEventListener/useEventListener.d.ts +5 -2
  426. package/dist/types/hooks/useEventSource/useEventSource.d.ts +1 -0
  427. package/dist/types/hooks/useEyeDropper/useEyeDropper.d.ts +1 -0
  428. package/dist/types/hooks/useFavicon/useFavicon.d.ts +2 -1
  429. package/dist/types/hooks/useField/useField.d.ts +1 -0
  430. package/dist/types/hooks/useFileDialog/useFileDialog.d.ts +1 -0
  431. package/dist/types/hooks/useFocus/useFocus.d.ts +25 -0
  432. package/dist/types/hooks/useFps/useFps.d.ts +1 -0
  433. package/dist/types/hooks/useFul/useFul.d.ts +1 -0
  434. package/dist/types/hooks/useFullscreen/useFullscreen.d.ts +1 -0
  435. package/dist/types/hooks/useGamepad/useGamepad.d.ts +1 -0
  436. package/dist/types/hooks/useGeolocation/useGeolocation.d.ts +1 -0
  437. package/dist/types/hooks/useHash/useHash.d.ts +1 -0
  438. package/dist/types/hooks/useHotkeys/useHotkeys.d.ts +1 -0
  439. package/dist/types/hooks/useHover/useHover.d.ts +3 -0
  440. package/dist/types/hooks/useIdle/useIdle.d.ts +1 -0
  441. package/dist/types/hooks/useImage/useImage.d.ts +1 -0
  442. package/dist/types/hooks/useInfiniteScroll/useInfiniteScroll.d.ts +1 -0
  443. package/dist/types/hooks/useIntersectionObserver/useIntersectionObserver.d.ts +15 -6
  444. package/dist/types/hooks/useInterval/useInterval.d.ts +1 -0
  445. package/dist/types/hooks/useIsFirstRender/useIsFirstRender.d.ts +1 -0
  446. package/dist/types/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts +1 -0
  447. package/dist/types/hooks/useKeyPress/useKeyPress.d.ts +1 -0
  448. package/dist/types/hooks/useKeyPressEvent/useKeyPressEvent.d.ts +1 -0
  449. package/dist/types/hooks/useKeyboard/useKeyboard.d.ts +1 -0
  450. package/dist/types/hooks/useKeysPressed/useKeysPressed.d.ts +1 -2
  451. package/dist/types/hooks/useLastChanged/useLastChanged.d.ts +1 -0
  452. package/dist/types/hooks/useLatest/useLatest.d.ts +1 -0
  453. package/dist/types/hooks/useLess/useLess.d.ts +1 -0
  454. package/dist/types/hooks/useList/useList.d.ts +1 -0
  455. package/dist/types/hooks/useLocalStorage/useLocalStorage.d.ts +1 -0
  456. package/dist/types/hooks/useLockCallback/useLockCallback.d.ts +1 -0
  457. package/dist/types/hooks/useLockScroll/useLockScroll.d.ts +1 -1
  458. package/dist/types/hooks/useLogger/useLogger.d.ts +1 -0
  459. package/dist/types/hooks/useLongPress/useLongPress.d.ts +1 -0
  460. package/dist/types/hooks/useMap/useMap.d.ts +1 -0
  461. package/dist/types/hooks/useMeasure/useMeasure.d.ts +1 -0
  462. package/dist/types/hooks/useMediaControls/useMediaControls.d.ts +1 -0
  463. package/dist/types/hooks/useMediaQuery/useMediaQuery.d.ts +1 -0
  464. package/dist/types/hooks/useMemory/useMemory.d.ts +1 -0
  465. package/dist/types/hooks/useMergedRef/useMergedRef.d.ts +17 -0
  466. package/dist/types/hooks/useMount/useMount.d.ts +1 -0
  467. package/dist/types/hooks/useMouse/useMouse.d.ts +1 -0
  468. package/dist/types/hooks/useMutation/useMutation.d.ts +1 -0
  469. package/dist/types/hooks/useMutationObserver/useMutationObserver.d.ts +43 -26
  470. package/dist/types/hooks/useNetwork/useNetwork.d.ts +1 -0
  471. package/dist/types/hooks/useObject/useObject.d.ts +1 -0
  472. package/dist/types/hooks/useOffsetPagination/useOffsetPagination.d.ts +1 -0
  473. package/dist/types/hooks/useOnce/useOnce.d.ts +1 -0
  474. package/dist/types/hooks/useOnline/useOnline.d.ts +1 -0
  475. package/dist/types/hooks/useOperatingSystem/useOperatingSystem.d.ts +1 -0
  476. package/dist/types/hooks/useOptimistic/useOptimistic.d.ts +1 -0
  477. package/dist/types/hooks/useOrientation/useOrientation.d.ts +2 -1
  478. package/dist/types/hooks/useOtpCredential/useOtpCredential.d.ts +1 -0
  479. package/dist/types/hooks/usePageLeave/usePageLeave.d.ts +1 -0
  480. package/dist/types/hooks/usePaint/usePaint.d.ts +1 -0
  481. package/dist/types/hooks/useParallax/useParallax.d.ts +1 -0
  482. package/dist/types/hooks/usePerformanceObserver/usePerformanceObserver.d.ts +1 -0
  483. package/dist/types/hooks/usePermission/usePermission.d.ts +1 -0
  484. package/dist/types/hooks/usePictureInPicture/usePictureInPicture.d.ts +1 -0
  485. package/dist/types/hooks/usePointerLock/usePointerLock.d.ts +1 -0
  486. package/dist/types/hooks/usePostMessage/usePostMessage.d.ts +1 -0
  487. package/dist/types/hooks/usePreferredColorScheme/usePreferredColorScheme.d.ts +1 -0
  488. package/dist/types/hooks/usePreferredContrast/usePreferredContrast.d.ts +1 -0
  489. package/dist/types/hooks/usePreferredDark/usePreferredDark.d.ts +1 -0
  490. package/dist/types/hooks/usePreferredLanguages/usePreferredLanguages.d.ts +1 -0
  491. package/dist/types/hooks/usePreferredReducedMotion/usePreferredReducedMotion.d.ts +1 -0
  492. package/dist/types/hooks/usePrevious/usePrevious.d.ts +1 -0
  493. package/dist/types/hooks/useQuery/useQuery.d.ts +1 -0
  494. package/dist/types/hooks/useQueue/useQueue.d.ts +1 -0
  495. package/dist/types/hooks/useRaf/useRaf.d.ts +1 -0
  496. package/dist/types/hooks/useRafState/useRafState.d.ts +3 -0
  497. package/dist/types/hooks/useRefState/useRefState.d.ts +1 -0
  498. package/dist/types/hooks/useRenderCount/useRenderCount.d.ts +1 -0
  499. package/dist/types/hooks/useRenderInfo/useRenderInfo.d.ts +1 -0
  500. package/dist/types/hooks/useRerender/useRerender.d.ts +1 -0
  501. package/dist/types/hooks/useResizeObserver/useResizeObserver.d.ts +55 -31
  502. package/dist/types/hooks/useRightClick/useRightClick.d.ts +1 -0
  503. package/dist/types/hooks/useScript/useScript.d.ts +1 -0
  504. package/dist/types/hooks/useScroll/useScroll.d.ts +4 -3
  505. package/dist/types/hooks/useScrollIntoView/useScrollIntoView.d.ts +7 -4
  506. package/dist/types/hooks/useScrollTo/useScrollTo.d.ts +13 -6
  507. package/dist/types/hooks/useSessionStorage/useSessionStorage.d.ts +1 -0
  508. package/dist/types/hooks/useSet/useSet.d.ts +1 -0
  509. package/dist/types/hooks/useShallowEffect/useShallowEffect.d.ts +1 -0
  510. package/dist/types/hooks/useShare/useShare.d.ts +1 -0
  511. package/dist/types/hooks/useSpeechRecognition/useSpeechRecognition.d.ts +1 -0
  512. package/dist/types/hooks/useSpeechSynthesis/useSpeechSynthesis.d.ts +1 -0
  513. package/dist/types/hooks/useStateHistory/useStateHistory.d.ts +1 -0
  514. package/dist/types/hooks/useStep/useStep.d.ts +1 -0
  515. package/dist/types/hooks/useSticky/useSticky.d.ts +1 -0
  516. package/dist/types/hooks/useStopwatch/useStopwatch.d.ts +1 -0
  517. package/dist/types/hooks/useStorage/useStorage.d.ts +1 -0
  518. package/dist/types/hooks/useTextDirection/useTextDirection.d.ts +1 -0
  519. package/dist/types/hooks/useTextSelection/useTextSelection.d.ts +1 -0
  520. package/dist/types/hooks/useThrottleCallback/useThrottleCallback.d.ts +1 -0
  521. package/dist/types/hooks/useThrottleState/useThrottleState.d.ts +15 -0
  522. package/dist/types/hooks/useThrottleValue/useThrottleValue.d.ts +1 -0
  523. package/dist/types/hooks/useTime/useTime.d.ts +1 -0
  524. package/dist/types/hooks/useTimeout/useTimeout.d.ts +1 -0
  525. package/dist/types/hooks/useTimer/useTimer.d.ts +1 -0
  526. package/dist/types/hooks/useToggle/useToggle.d.ts +1 -0
  527. package/dist/types/hooks/useUnmount/useUnmount.d.ts +1 -0
  528. package/dist/types/hooks/useUrlSearchParam/useUrlSearchParam.d.ts +1 -0
  529. package/dist/types/hooks/useUrlSearchParams/useUrlSearchParams.d.ts +1 -0
  530. package/dist/types/hooks/useVibrate/useVibrate.d.ts +1 -0
  531. package/dist/types/hooks/useVirtualKeyboard/useVirtualKeyboard.d.ts +1 -0
  532. package/dist/types/hooks/useWakeLock/useWakeLock.d.ts +1 -0
  533. package/dist/types/hooks/useWebSocket/useWebSocket.d.ts +17 -0
  534. package/dist/types/hooks/useWindowEvent/useWindowEvent.d.ts +1 -0
  535. package/dist/types/hooks/useWindowFocus/useWindowFocus.d.ts +1 -0
  536. package/dist/types/hooks/useWindowScroll/useWindowScroll.d.ts +1 -0
  537. package/dist/types/hooks/useWindowSize/useWindowSize.d.ts +1 -0
  538. package/dist/types/hooks/useWizard/useWizard.d.ts +1 -0
  539. package/dist/types/hooks/utilities.d.ts +2 -0
  540. package/package.json +89 -89
@@ -1,49 +1,73 @@
1
1
  import { HookTarget } from '../../utils/helpers';
2
2
  import { StateRef } from '../useRefState/useRefState';
3
+ /** The resize observer callback type */
4
+ export type UseResizeObserverCallback = (entry: ResizeObserverEntry, observer: ResizeObserver) => void;
3
5
  /** The resize observer options type */
4
6
  export interface UseResizeObserverOptions extends ResizeObserverOptions {
5
- /** The enabled state */
7
+ /** The enabled state of the resize observer */
6
8
  enabled?: boolean;
7
- /** The resize observer callback */
8
- onChange?: (entries: ResizeObserverEntry[], observer: ResizeObserver) => void;
9
+ /** The callback to execute when resize is detected */
10
+ onChange?: UseResizeObserverCallback;
9
11
  }
10
12
  /** The resize observer return type */
11
13
  export interface UseResizeObserverReturn {
12
14
  /** The resize observer entries */
13
- entries: ResizeObserverEntry[];
15
+ entry: ResizeObserverEntry;
16
+ /** The resize observer instance */
17
+ observer?: ResizeObserver;
14
18
  }
15
19
  export interface UseResizeObserver {
16
- (target: HookTarget, options?: UseResizeObserverOptions): UseResizeObserverReturn;
17
20
  <Target extends Element>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
18
21
  ref: StateRef<Target>;
19
22
  };
23
+ (target: HookTarget, options?: UseResizeObserverOptions): UseResizeObserverReturn;
24
+ <Target extends Element>(callback: UseResizeObserverCallback, target?: never): UseResizeObserverReturn & {
25
+ ref: StateRef<Target>;
26
+ };
27
+ (target: HookTarget, callback: UseResizeObserverCallback): UseResizeObserverReturn;
20
28
  }
21
29
  /**
22
- * @name useResizeObserver
23
- * @description - Hook that gives you resize observer state
24
- * @category Sensors
25
- *
26
- * @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
27
- *
28
- * @overload
29
- * @template Target The target element
30
- * @param {boolean} [options.enabled=true] The IntersectionObserver options
31
- * @param {boolean} [options.box] The IntersectionObserver options
32
- * @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
33
- * @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} An object containing the resize observer state
34
- *
35
- * @example
36
- * const { ref, entries } = useResizeObserver();
37
- *
38
- * @overload
39
- * @template Target The target element
40
- * @param {HookTarget} target The target element to observe
41
- * @param {boolean} [options.enabled=true] The IntersectionObserver options
42
- * @param {boolean} [options.box] The IntersectionObserver options
43
- * @param {(entries: ResizeObserverEntry[], observer: ResizeObserver) => void} [options.onChange] The callback to execute when resize is detected
44
- * @returns {UseResizeObserverReturn} An object containing the resize observer state
45
- *
46
- * @example
47
- * const { entries } = useResizeObserver(ref);
30
+ * @name useResizeObserver
31
+ * @description - Hook that gives you resize observer state
32
+ * @category Sensors
33
+ * @usage low
34
+ *
35
+ * @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
36
+ *
37
+ * @overload
38
+ * @param {HookTarget} target The target element to observe
39
+ * @param {boolean} [options.enabled=true] The enabled state of the resize observer
40
+ * @param {ResizeObserverBoxOptions} [options.box] The box model to observe
41
+ * @param {UseResizeObserverCallback} [options.onChange] The callback to execute when resize is detected
42
+ * @returns {UseResizeObserverReturn} An object containing the resize observer state
43
+ *
44
+ * @example
45
+ * const { entries, observer } = useResizeObserver(ref);
46
+ *
47
+ * @overload
48
+ * @template Target The target element
49
+ * @param {boolean} [options.enabled=true] The enabled state of the resize observer
50
+ * @param {ResizeObserverBoxOptions} [options.box] The box model to observe
51
+ * @param {UseResizeObserverCallback} [options.onChange] The callback to execute when resize is detected
52
+ * @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
53
+ *
54
+ * @example
55
+ * const { ref, entry, observer } = useResizeObserver();
56
+ *
57
+ * @overload
58
+ * @template Target The target element
59
+ * @param {UseResizeObserverCallback} callback The callback to execute when resize is detected
60
+ * @returns {UseResizeObserverReturn & { ref: StateRef<Target> }} A React ref to attach to the target element
61
+ *
62
+ * @example
63
+ * const { ref, entry, observer } = useResizeObserver((entry) => console.log(entry));
64
+ *
65
+ * @overload
66
+ * @param {HookTarget} target The target element to observe
67
+ * @param {UseResizeObserverCallback} callback The callback to execute when resize is detected
68
+ * @returns {UseResizeObserverReturn} An object containing the resize observer state
69
+ *
70
+ * @example
71
+ * const { entry, observer } = useResizeObserver(ref, (entry) => console.log(entry));
48
72
  */
49
73
  export declare const useResizeObserver: UseResizeObserver;
@@ -17,6 +17,7 @@ export interface UseRightClick {
17
17
  * @name useRightClick
18
18
  * @description - Hook that handles right-click events and long press on mobile devices
19
19
  * @category Elements
20
+ * @usage low
20
21
  *
21
22
  * @overload
22
23
  * @param {HookTarget} target The target element for right-click handling
@@ -11,6 +11,7 @@ export interface UseScriptOptions extends ComponentProps<'script'> {
11
11
  * @name useScript
12
12
  * @description - Hook that manages a script with onLoad, onError, and removeOnUnmount functionalities
13
13
  * @category Elements
14
+ * @usage low
14
15
  *
15
16
  * @param {string} src The source of the script
16
17
  * @param {UseScriptOptions} [options] The options of the script extends from attributes script tag
@@ -34,8 +34,8 @@ export interface UseScrollCallbackParams {
34
34
  };
35
35
  }
36
36
  export interface UseScroll {
37
- (target: HookTarget, callback?: (params: UseScrollCallbackParams, event: Event) => void): boolean;
38
- (target: HookTarget, options?: UseScrollOptions): boolean;
37
+ (target?: HookTarget, callback?: (params: UseScrollCallbackParams, event: Event) => void): boolean;
38
+ (target?: HookTarget, options?: UseScrollOptions): boolean;
39
39
  <Target extends Element>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): {
40
40
  ref: StateRef<Target>;
41
41
  scrolling: boolean;
@@ -49,6 +49,7 @@ export interface UseScroll {
49
49
  * @name useScroll
50
50
  * @description - Hook that allows you to control scroll a element
51
51
  * @category Sensors
52
+ * @usage low
52
53
  *
53
54
  * @overload
54
55
  * @template Target The target element
@@ -74,7 +75,7 @@ export interface UseScroll {
74
75
  *
75
76
  * @overload
76
77
  * @template Target The target element
77
- * @param {Target} target The target element to scroll
78
+ * @param {Target} [target=window] The target element to scroll
78
79
  * @param {ScrollBehavior} [options.behavior=auto] The behavior of scrolling
79
80
  * @param {number} [options.offset.left=0] The left offset for arrived states
80
81
  * @param {number} [options.offset.right=0] The right offset for arrived states
@@ -2,8 +2,8 @@ import { HookTarget } from '../../utils/helpers';
2
2
  import { StateRef } from '../useRefState/useRefState';
3
3
  /** The scroll into view options type */
4
4
  export interface UseScrollIntoViewOptions extends ScrollIntoViewOptions {
5
- /** Whether to enable the scroll into view */
6
- enabled?: boolean;
5
+ /** Whether to immediately the scroll into view */
6
+ immediately?: boolean;
7
7
  }
8
8
  /** The scroll into view return type */
9
9
  export interface UseScrollIntoViewReturn {
@@ -18,15 +18,17 @@ export interface UseScrollIntoView {
18
18
  <Target extends Element>(options?: UseScrollIntoViewOptions, target?: never): UseScrollIntoViewReturn & {
19
19
  ref: StateRef<Target>;
20
20
  };
21
- (target: HookTarget, options?: UseScrollIntoViewOptions): UseScrollIntoViewReturn;
21
+ (target?: HookTarget, options?: UseScrollIntoViewOptions): UseScrollIntoViewReturn;
22
22
  }
23
23
  /**
24
24
  * @name useScrollIntoView
25
25
  * @description - Hook that provides functionality to scroll an element into view
26
26
  * @category Sensors
27
+ * @usage low
27
28
  *
28
29
  * @overload
29
- * @param {HookTarget} target The target element to scroll into view
30
+ * @param {HookTarget} [target=window] The target element to scroll into view
31
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
30
32
  * @param {ScrollBehavior} [options.behavior='smooth'] The scrolling behavior
31
33
  * @param {ScrollLogicalPosition} [options.block='start'] The vertical alignment
32
34
  * @param {ScrollLogicalPosition} [options.inline='nearest'] The horizontal alignment
@@ -37,6 +39,7 @@ export interface UseScrollIntoView {
37
39
  *
38
40
  * @overload
39
41
  * @template Target The target element
42
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
40
43
  * @param {ScrollBehavior} [options.behavior='smooth'] The scrolling behavior
41
44
  * @param {ScrollLogicalPosition} [options.block='start'] The vertical alignment
42
45
  * @param {ScrollLogicalPosition} [options.inline='nearest'] The horizontal alignment
@@ -4,8 +4,8 @@ import { StateRef } from '../useRefState/useRefState';
4
4
  export interface UseScrollToOptions {
5
5
  /** The scrolling behavior */
6
6
  behavior?: ScrollBehavior;
7
- /** Whether to enable the scroll to */
8
- enabled?: boolean;
7
+ /** Whether to immediately the scroll to */
8
+ immediately?: boolean;
9
9
  /** The horizontal position to scroll to */
10
10
  x: number;
11
11
  /** The vertical position to scroll to */
@@ -24,16 +24,20 @@ export interface UseScrollTo {
24
24
  <Target extends Element>(options?: UseScrollToOptions, target?: never): UseScrollToReturn & {
25
25
  ref: StateRef<Target>;
26
26
  };
27
- (target: HookTarget, options?: UseScrollToOptions): UseScrollToReturn;
27
+ (target?: HookTarget, options?: UseScrollToOptions): UseScrollToReturn;
28
28
  }
29
29
  /**
30
30
  * @name useScrollTo
31
31
  * @description - Hook for scrolling to a specific element
32
32
  * @category Sensors
33
+ * @usage low
33
34
  *
34
35
  * @overload
35
- * @param {HookTarget} target The target element for scrolling to
36
- * @param {UseScrollToOptions} [options] The scroll options
36
+ * @param {HookTarget} [target=window] The target element for scrolling to
37
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
38
+ * @param {number} [options.x] The horizontal position to scroll to
39
+ * @param {number} [options.y] The vertical position to scroll to
40
+ * @param {ScrollBehavior} [options.behavior=auto] The scrolling behavior
37
41
  * @returns {UseScrollToReturn} The scroll trigger function
38
42
  *
39
43
  * @example
@@ -41,7 +45,10 @@ export interface UseScrollTo {
41
45
  *
42
46
  * @overload
43
47
  * @template Target The target element
44
- * @param {UseScrollToOptions} [options] The scroll options
48
+ * @param {boolean} [options.immediately=true] Whether to scroll immediately
49
+ * @param {number} [options.x] The horizontal position to scroll to
50
+ * @param {number} [options.y] The vertical position to scroll to
51
+ * @param {ScrollBehavior} [options.behavior=auto] The scrolling behavior
45
52
  * @returns {UseScrollToReturn & { ref: StateRef<Target> }} The scroll trigger function and ref
46
53
  *
47
54
  * @example
@@ -3,6 +3,7 @@ import { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStor
3
3
  * @name useSessionStorage
4
4
  * @description - Hook that manages session storage value
5
5
  * @category State
6
+ * @usage medium
6
7
  *
7
8
  * @browserapi sessionStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
8
9
  *
@@ -29,6 +29,7 @@ interface UseSetReturn<Value> {
29
29
  * @name useSet
30
30
  * @description - Hook that manages a set structure
31
31
  * @category State
32
+ * @usage medium
32
33
  *
33
34
  * @template Value The type of the value
34
35
  * @param {Value[]} [values] The initial array of the set
@@ -4,6 +4,7 @@ export declare const deepEqual: (a: any, b: any) => boolean;
4
4
  * @name useShallowEffect
5
5
  * @description - Hook that executes an effect only when dependencies change shallowly or deeply
6
6
  * @category Lifecycle
7
+ * @usage low
7
8
  *
8
9
  * @param {EffectCallback} effect The effect callback
9
10
  * @param {DependencyList} [deps] The dependencies list for the effect
@@ -20,6 +20,7 @@ export interface UseShareReturn {
20
20
  * @name useShare
21
21
  * @description - Hook that utilizes the share api
22
22
  * @category Browser
23
+ * @usage medium
23
24
  *
24
25
  * @browserapi share https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share
25
26
  *
@@ -48,6 +48,7 @@ export declare const getSpeechRecognition: () => {
48
48
  * @name useSpeechRecognition
49
49
  * @description - Hook that provides a streamlined interface for incorporating speech-to-text functionality
50
50
  * @category Browser
51
+ * @usage low
51
52
  *
52
53
  * @browserapi window.SpeechRecognition https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition
53
54
  *
@@ -42,6 +42,7 @@ export interface UseSpeechSynthesisReturn {
42
42
  * @name useSpeechSynthesis
43
43
  * @description - Hook that provides speech synthesis functionality
44
44
  * @category Browser
45
+ * @usage low
45
46
  *
46
47
  * @browserapi SpeechSynthesis https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis
47
48
  *
@@ -61,6 +61,7 @@ export declare const stateHistoryReducer: <Value>(state: StateHistory<Value>, ac
61
61
  * @name useStateHistory
62
62
  * @description - Hook that manages state with history functionality
63
63
  * @category State
64
+ * @usage medium
64
65
  *
65
66
  * @param {Value} initialValue - The initial value to start the history with
66
67
  * @param {number} [capacity=10] - Maximum number of history entries and undo actions to keep
@@ -28,6 +28,7 @@ export interface UseStepReturn {
28
28
  * @name useStep
29
29
  * @description - Hook that create stepper
30
30
  * @category State
31
+ * @usage medium
31
32
  *
32
33
  * @overload
33
34
  * @param {number} max Maximum number of steps
@@ -21,6 +21,7 @@ export interface UseSticky {
21
21
  * @name UseSticky
22
22
  * @description - Hook that allows you to detect that your sticky component is stuck
23
23
  * @category Elements
24
+ * @usage low
24
25
  *
25
26
  * @overload
26
27
  * @param {HookTarget} target The target sticky element
@@ -38,6 +38,7 @@ interface UseStopwatch {
38
38
  * @name useStopwatch
39
39
  * @description - Hook that creates a stopwatch functionality
40
40
  * @category Time
41
+ * @usage high
41
42
  *
42
43
  * @overload
43
44
  * @param {number} [initialTime=0] The initial time of the timer
@@ -20,6 +20,7 @@ export declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => bo
20
20
  * @name useStorage
21
21
  * @description - Hook that manages storage value
22
22
  * @category State
23
+ * @usage high
23
24
  *
24
25
  * @overload
25
26
  * @param {string} key The key of the storage
@@ -21,6 +21,7 @@ export interface UseTextDirection {
21
21
  * @name useTextDirection
22
22
  * @description - Hook that can get and set the direction of the element
23
23
  * @category Elements
24
+ * @usage medium
24
25
  *
25
26
  * @overload
26
27
  * @param {HookTarget} [target=document.querySelector('html')] The target element to observe
@@ -14,6 +14,7 @@ export interface UseTextSelectionReturn {
14
14
  * @name useTextSelection
15
15
  * @description - Hook that manages the text selection
16
16
  * @category Sensors
17
+ * @usage low
17
18
  *
18
19
  * @browserapi document.getSelection https://developer.mozilla.org/en-US/docs/Web/API/Document/getSelection
19
20
  *
@@ -5,6 +5,7 @@ export type ThrottledCallback<Params extends unknown[]> = ((...args: Params) =>
5
5
  * @name useThrottleCallback
6
6
  * @description - Hook that creates a throttled callback
7
7
  * @category Utilities
8
+ * @usage medium
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 useThrottleState
3
+ * @description - Hook that creates a throttled state
4
+ * @category Utilities
5
+ * @usage medium
6
+ *
7
+ * @template Value The type of the value
8
+ * @param {Value} value The value to be throttled
9
+ * @param {number} delay The delay in milliseconds
10
+ * @returns {[Value, (value: Value) => void]} The throttled state
11
+ *
12
+ * @example
13
+ * const [throttledValue, setThrottledValue] = useThrottleState(value, 500);
14
+ */
15
+ export declare const useThrottleState: <Value>(initialValue: Value, delay: number) => readonly [Value, import('..').ThrottledCallback<[value: import('react').SetStateAction<Value>]>];
@@ -2,6 +2,7 @@
2
2
  * @name useThrottleValue
3
3
  * @description - Hook that creates a throttled value
4
4
  * @category Utilities
5
+ * @usage medium
5
6
  *
6
7
  * @template Value The type of the value
7
8
  * @param {Value} value The value to be throttled
@@ -23,6 +23,7 @@ export interface UseTimeReturn {
23
23
  * @name useTime
24
24
  * @description - Hook that gives you current time in different values
25
25
  * @category Time
26
+ * @usage medium
26
27
  *
27
28
  * @returns {UseTimeReturn} An object containing the current time
28
29
  *
@@ -9,6 +9,7 @@ interface UseTimeoutReturn {
9
9
  * @name useTimeout
10
10
  * @description - Hook that executes a callback function after a specified delay
11
11
  * @category Time
12
+ * @usage medium
12
13
  *
13
14
  * @param {() => void} callback The function to be executed after the timeout
14
15
  * @param {number} delay The delay in milliseconds before the timeout executes the callback function
@@ -56,6 +56,7 @@ export interface UseTimer {
56
56
  * @name useTimer
57
57
  * @description - Hook that creates a timer functionality
58
58
  * @category Time
59
+ * @usage medium
59
60
  *
60
61
  * @overload
61
62
  * @returns {UseTimerReturn} An object containing the timer properties and functions
@@ -5,6 +5,7 @@ export type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
5
5
  * @name useToggle
6
6
  * @description - Hook that create toggle
7
7
  * @category State
8
+ * @usage high
8
9
  *
9
10
  * @template Value The type of the value
10
11
  * @param {Value[]} [values=[false, true]] The values to toggle
@@ -2,6 +2,7 @@
2
2
  * @name useUnmount
3
3
  * @description - Hook that defines the logic when unmounting a component
4
4
  * @category Lifecycle
5
+ * @usage necessary
5
6
  *
6
7
  * @param {() => void} callback The callback function to be invoked on component unmount
7
8
  * @returns {void}
@@ -43,6 +43,7 @@ export interface UseUrlSearchParam {
43
43
  * @name useUrlSearchParam
44
44
  * @description - Hook that provides reactive URLSearchParams for a single key
45
45
  * @category State
46
+ * @usage high
46
47
  *
47
48
  * @overload
48
49
  * @template Value The type of the url param values
@@ -38,6 +38,7 @@ export interface UseUrlSearchParams {
38
38
  * @name useUrlSearchParams
39
39
  * @description - Hook that provides reactive URLSearchParams
40
40
  * @category State
41
+ * @usage high
41
42
  *
42
43
  * @overload
43
44
  * @template Value The type of the url param values
@@ -19,6 +19,7 @@ export interface UseVibrateReturn {
19
19
  * @name useVibrate
20
20
  * @description - Hook that provides vibrate api
21
21
  * @category Browser
22
+ * @usage low
22
23
  *
23
24
  * @browserapi navigator.vibrate https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate
24
25
  *
@@ -27,6 +27,7 @@ export interface UseVirtualKeyboardReturn {
27
27
  * @name useVirtualKeyboard
28
28
  * @description - Hook that manages virtual keyboard state
29
29
  * @category Browser
30
+ * @usage low
30
31
  *
31
32
  * @browserapi VirtualKeyboard https://developer.mozilla.org/en-US/docs/Web/API/VirtualKeyboard
32
33
  *
@@ -20,6 +20,7 @@ export interface UseWakeLockReturn {
20
20
  * @name useWakeLock
21
21
  * @description - Hook that provides a wake lock functionality
22
22
  * @category Browser
23
+ * @usage low
23
24
  *
24
25
  * @browserapi navigator.wakeLock https://developer.mozilla.org/en-US/docs/Web/API/WakeLock
25
26
  *
@@ -1,24 +1,41 @@
1
+ /** The use web socket url type */
1
2
  export type UseWebSocketUrl = (() => string) | string;
3
+ /** The use web socket options type */
2
4
  export interface UseWebSocketOptions {
5
+ /** The list of protocols to use */
3
6
  protocols?: Array<'soap' | 'wasm'>;
7
+ /** The number of times to retry the connection */
4
8
  retry?: boolean | number;
9
+ /** The callback function that is called when the WebSocket connection is established */
5
10
  onConnected?: (webSocket: WebSocket) => void;
11
+ /** The callback function that is called when the WebSocket connection is closed */
6
12
  onDisconnected?: (event: CloseEvent, webSocket: WebSocket) => void;
13
+ /** The callback function that is called when an error occurs */
7
14
  onError?: (event: Event, webSocket: WebSocket) => void;
15
+ /** The callback function that is called when a message is received */
8
16
  onMessage?: (event: MessageEvent, webSocket: WebSocket) => void;
9
17
  }
10
18
  export type UseWebSocketStatus = 'connected' | 'connecting' | 'disconnected' | 'failed';
19
+ /** The use web socket return type */
11
20
  export interface UseWebSocketReturn {
21
+ /** The WebSocket client */
12
22
  client?: WebSocket;
23
+ /** The close function */
13
24
  close: WebSocket['close'];
25
+ /** The send function */
14
26
  send: WebSocket['send'];
27
+ /** The status of the WebSocket connection */
15
28
  status: UseWebSocketStatus;
29
+ /** The open function */
16
30
  open: () => void;
17
31
  }
18
32
  /**
19
33
  * @name useWebSocket
20
34
  * @description - Hook that connects to a WebSocket server and handles incoming and outgoing messages
21
35
  * @category Browser
36
+ * @usage medium
37
+ *
38
+ * @browserapi WebSocket https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
22
39
  *
23
40
  * @param {UseWebSocketUrl} url The URL of the WebSocket server
24
41
  * @param {(webSocket: WebSocket) => void} [options.onConnected] The callback function that is called when the WebSocket connection is established
@@ -3,6 +3,7 @@ import { UseEventListenerOptions } from '../useEventListener/useEventListener';
3
3
  * @name useWindowEvent
4
4
  * @description - Hook attaches an event listener to the window object for the specified event
5
5
  * @category Sensors
6
+ * @usage low
6
7
  *
7
8
  * @template Event Key of window event map.
8
9
  * @param {Event} event The event to listen for.
@@ -2,6 +2,7 @@
2
2
  * @name useWindowFocus
3
3
  * @description - Hook that provides the current focus state of the window
4
4
  * @category Elements
5
+ * @usage low
5
6
  *
6
7
  * @returns {boolean} The current focus state of the window
7
8
  *
@@ -7,6 +7,7 @@ export declare const scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & Scr
7
7
  * @name useWindowScroll
8
8
  * @description - Hook that manages the window scroll position
9
9
  * @category Sensors
10
+ * @usage low
10
11
  *
11
12
  * @returns {UseWindowScrollReturn} An object containing the current window scroll position
12
13
  *
@@ -14,6 +14,7 @@ export interface UseWindowSizeReturn {
14
14
  * @name useWindowSize
15
15
  * @description - Hook that manages a window size
16
16
  * @category Elements
17
+ * @usage low
17
18
  *
18
19
  * @param {number} [params.initialWidth=Number.POSITIVE_INFINITY] The initial window width
19
20
  * @param {number} [params.initialHeight=Number.POSITIVE_INFINITY] The initial window height
@@ -6,6 +6,7 @@ export interface WizardItem<WizardStepId> {
6
6
  * @name useWizard
7
7
  * @description - Hook that manages a wizard
8
8
  * @category State
9
+ * @usage medium
9
10
  *
10
11
  * @param {WizardItem<WizardStepId>[]} map The map of the wizard
11
12
  * @param {WizardStepId} [initialStepId] The initial step id
@@ -1,9 +1,11 @@
1
1
  export * from './useConst/useConst';
2
2
  export * from './useDebounceCallback/useDebounceCallback';
3
+ export * from './useDebounceState/useDebounceState';
3
4
  export * from './useDebounceValue/useDebounceValue';
4
5
  export * from './useEvent/useEvent';
5
6
  export * from './useLastChanged/useLastChanged';
6
7
  export * from './useLatest/useLatest';
7
8
  export * from './usePrevious/usePrevious';
8
9
  export * from './useThrottleCallback/useThrottleCallback';
10
+ export * from './useThrottleState/useThrottleState';
9
11
  export * from './useThrottleValue/useThrottleValue';