@siberiacancode/reactuse 0.0.64 → 0.0.66

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 (313) hide show
  1. package/README.md +12 -19
  2. package/dist/cjs/_rollupPluginBabelHelpers-DA8CS73W.js +3 -0
  3. package/dist/cjs/_rollupPluginBabelHelpers-DA8CS73W.js.map +1 -0
  4. package/dist/cjs/hooks/index.js +2 -2
  5. package/dist/cjs/hooks/useAsync/useAsync.js +2 -2
  6. package/dist/cjs/hooks/useAsync/useAsync.js.map +1 -1
  7. package/dist/cjs/hooks/useBattery/useBattery.js +2 -2
  8. package/dist/cjs/hooks/useBoolean/useBoolean.js +2 -2
  9. package/dist/cjs/hooks/useBreakpoints/constants/breakpoints.js +1 -1
  10. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.js +2 -2
  11. package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  12. package/dist/cjs/hooks/useClickOutside/useClickOutside.js +2 -2
  13. package/dist/cjs/hooks/useClickOutside/useClickOutside.js.map +1 -1
  14. package/dist/cjs/hooks/useClipboard/useClipboard.js +2 -2
  15. package/dist/cjs/hooks/useCounter/useCounter.js +2 -2
  16. package/dist/cjs/hooks/useCounter/useCounter.js.map +1 -1
  17. package/dist/cjs/hooks/useCssVar/useCssVar.js +2 -2
  18. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  19. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.js +2 -2
  20. package/dist/cjs/hooks/useDefault/useDefault.js +2 -2
  21. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js +3 -0
  22. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -0
  23. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js +3 -0
  24. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -0
  25. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.js +1 -1
  26. package/dist/cjs/hooks/useDisclosure/useDisclosure.js +2 -2
  27. package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  28. package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  29. package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  30. package/dist/cjs/hooks/useEvent/useEvent.js +1 -1
  31. package/dist/cjs/hooks/useEventListener/useEventListener.js +2 -2
  32. package/dist/cjs/hooks/useEventListener/useEventListener.js.map +1 -1
  33. package/dist/cjs/hooks/useEyeDropper/useEyeDropper.js +2 -2
  34. package/dist/cjs/hooks/useFavicon/useFavicon.js +2 -2
  35. package/dist/cjs/hooks/useField/useField.js +2 -2
  36. package/dist/cjs/hooks/useField/useField.js.map +1 -1
  37. package/dist/cjs/hooks/useFileDialog/useFileDialog.js +2 -2
  38. package/dist/cjs/hooks/useFileDialog/useFileDialog.js.map +1 -1
  39. package/dist/cjs/hooks/useFps/useFps.js +2 -2
  40. package/dist/cjs/hooks/useFps/useFps.js.map +1 -1
  41. package/dist/cjs/hooks/useFullscreen/useFullscreen.js +2 -2
  42. package/dist/cjs/hooks/useFullscreen/useFullscreen.js.map +1 -1
  43. package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +1 -1
  44. package/dist/cjs/hooks/useGamepad/useGamepad.js +2 -2
  45. package/dist/cjs/hooks/useGeolocation/useGeolocation.js +2 -2
  46. package/dist/cjs/hooks/useHash/useHash.js +2 -2
  47. package/dist/cjs/hooks/useHotkeys/useHotkeys.js +2 -2
  48. package/dist/cjs/hooks/useHotkeys/useHotkeys.js.map +1 -1
  49. package/dist/cjs/hooks/useHover/useHover.js +2 -2
  50. package/dist/cjs/hooks/useHover/useHover.js.map +1 -1
  51. package/dist/cjs/hooks/useIdle/useIdle.js +2 -2
  52. package/dist/cjs/hooks/useImage/useImage.js +2 -2
  53. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  54. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.js.map +1 -1
  55. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  56. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.js.map +1 -1
  57. package/dist/cjs/hooks/useInterval/useInterval.js +2 -2
  58. package/dist/cjs/hooks/useInterval/useInterval.js.map +1 -1
  59. package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  60. package/dist/cjs/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  61. package/dist/cjs/hooks/useKeyPress/useKeyPress.js +2 -2
  62. package/dist/cjs/hooks/useKeyPress/useKeyPress.js.map +1 -1
  63. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  64. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.js.map +1 -1
  65. package/dist/cjs/hooks/useKeyboard/useKeyboard.js +2 -2
  66. package/dist/cjs/hooks/useKeyboard/useKeyboard.js.map +1 -1
  67. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.js +2 -2
  68. package/dist/cjs/hooks/useList/useList.js +2 -2
  69. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.js +2 -2
  70. package/dist/cjs/hooks/useLogger/useLogger.js +2 -2
  71. package/dist/cjs/hooks/useLongPress/useLongPress.js +2 -2
  72. package/dist/cjs/hooks/useMap/useMap.js +2 -2
  73. package/dist/cjs/hooks/useMeasure/useMeasure.js +2 -2
  74. package/dist/cjs/hooks/useMeasure/useMeasure.js.map +1 -1
  75. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.js +1 -1
  76. package/dist/cjs/hooks/useMemory/useMemory.js +2 -2
  77. package/dist/cjs/hooks/useMount/useMount.js +1 -1
  78. package/dist/cjs/hooks/useMouse/useMouse.js +2 -2
  79. package/dist/cjs/hooks/useMouse/useMouse.js.map +1 -1
  80. package/dist/cjs/hooks/useMutation/useMutation.js +2 -2
  81. package/dist/cjs/hooks/useMutation/useMutation.js.map +1 -1
  82. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.js +2 -2
  83. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.js.map +1 -1
  84. package/dist/cjs/hooks/useNetwork/useNetwork.js +2 -2
  85. package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  86. package/dist/cjs/hooks/useOnline/useOnline.js +1 -1
  87. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.js +2 -2
  88. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.js.map +1 -1
  89. package/dist/cjs/hooks/useOptimistic/useOptimistic.js +3 -0
  90. package/dist/cjs/hooks/useOptimistic/useOptimistic.js.map +1 -0
  91. package/dist/cjs/hooks/useOrientation/useOrientation.js +2 -2
  92. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js +2 -2
  93. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  94. package/dist/cjs/hooks/usePageLeave/usePageLeave.js +2 -2
  95. package/dist/cjs/hooks/usePaint/helpers/Paint.js +2 -2
  96. package/dist/cjs/hooks/usePaint/helpers/Pointer.js +2 -2
  97. package/dist/cjs/hooks/usePaint/usePaint.js +2 -2
  98. package/dist/cjs/hooks/usePaint/usePaint.js.map +1 -1
  99. package/dist/cjs/hooks/useParallax/useParallax.js +3 -0
  100. package/dist/cjs/hooks/useParallax/useParallax.js.map +1 -0
  101. package/dist/cjs/hooks/usePermission/usePermission.js +2 -2
  102. package/dist/cjs/hooks/usePermission/usePermission.js.map +1 -1
  103. package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  104. package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  105. package/dist/cjs/hooks/usePreferredDark/usePreferredDark.js +1 -1
  106. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  107. package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  108. package/dist/cjs/hooks/usePrevious/usePrevious.js +1 -1
  109. package/dist/cjs/hooks/useQuery/useQuery.js +2 -2
  110. package/dist/cjs/hooks/useQuery/useQuery.js.map +1 -1
  111. package/dist/cjs/hooks/useQueue/useQueue.js +2 -2
  112. package/dist/cjs/hooks/useRaf/useRaf.js +2 -2
  113. package/dist/cjs/hooks/useRaf/useRaf.js.map +1 -1
  114. package/dist/cjs/hooks/useRafValue/useRafValue.js +2 -2
  115. package/dist/cjs/hooks/useRenderCount/useRenderCount.js +1 -1
  116. package/dist/cjs/hooks/useRenderInfo/useRenderInfo.js +1 -1
  117. package/dist/cjs/hooks/useRerender/useRerender.js +2 -2
  118. package/dist/cjs/hooks/useRerender/useRerender.js.map +1 -1
  119. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js +2 -2
  120. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  121. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js +3 -0
  122. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -0
  123. package/dist/cjs/hooks/useScript/useScript.js +2 -2
  124. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.js +2 -2
  125. package/dist/cjs/hooks/useSet/useSet.js +2 -2
  126. package/dist/cjs/hooks/useSet/useSet.js.map +1 -1
  127. package/dist/cjs/hooks/useShare/useShare.js +2 -2
  128. package/dist/cjs/hooks/useStep/useStep.js +2 -2
  129. package/dist/cjs/hooks/useStopwatch/useStopwatch.js +2 -2
  130. package/dist/cjs/hooks/useStopwatch/useStopwatch.js.map +1 -1
  131. package/dist/cjs/hooks/useStorage/useStorage.js +2 -2
  132. package/dist/cjs/hooks/useStorage/useStorage.js.map +1 -1
  133. package/dist/cjs/hooks/useTextSelection/useTextSelection.js +2 -2
  134. package/dist/cjs/hooks/useTime/useTime.js +2 -2
  135. package/dist/cjs/hooks/useTimeout/useTimeout.js +2 -2
  136. package/dist/cjs/hooks/useToggle/useToggle.js +2 -2
  137. package/dist/cjs/hooks/useUnmount/useUnmount.js +1 -1
  138. package/dist/cjs/hooks/useWebSocket/useWebSocket.js +2 -2
  139. package/dist/cjs/hooks/useWindowEvent/useWindowEvent.js +2 -2
  140. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.js +2 -2
  141. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.js.map +1 -1
  142. package/dist/cjs/hooks/useWindowSize/useWindowSize.js +2 -2
  143. package/dist/cjs/hooks/useWizard/useWizard.js +2 -2
  144. package/dist/cjs/{index-CYZjZMEr.js → index-DNTtg9NP.js} +2 -2
  145. package/dist/cjs/{index-CYZjZMEr.js.map → index-DNTtg9NP.js.map} +1 -1
  146. package/dist/cjs/index.js +2 -2
  147. package/dist/cjs/utils/helpers/debounce.js +1 -1
  148. package/dist/cjs/utils/helpers/getElement.js +1 -1
  149. package/dist/cjs/utils/helpers/getRetry.js +1 -1
  150. package/dist/cjs/utils/helpers/index.js +1 -1
  151. package/dist/cjs/utils/helpers/isClient.js +1 -1
  152. package/dist/cjs/utils/helpers/throttle.js +1 -1
  153. package/dist/cjs/utils/helpers/throttle.js.map +1 -1
  154. package/dist/cjs/utils/helpers/time/getDate.js +1 -1
  155. package/dist/esm/_rollupPluginBabelHelpers-CWXiPzDd.js +3 -0
  156. package/dist/esm/_rollupPluginBabelHelpers-CWXiPzDd.js.map +1 -0
  157. package/dist/esm/hooks/index.js +2 -2
  158. package/dist/esm/hooks/useAsync/useAsync.js +2 -2
  159. package/dist/esm/hooks/useAsync/useAsync.js.map +1 -1
  160. package/dist/esm/hooks/useBattery/useBattery.js +2 -2
  161. package/dist/esm/hooks/useBoolean/useBoolean.js +2 -2
  162. package/dist/esm/hooks/useBreakpoints/constants/breakpoints.js +1 -1
  163. package/dist/esm/hooks/useBreakpoints/useBreakpoints.js +2 -2
  164. package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  165. package/dist/esm/hooks/useClickOutside/useClickOutside.js +2 -2
  166. package/dist/esm/hooks/useClickOutside/useClickOutside.js.map +1 -1
  167. package/dist/esm/hooks/useClipboard/useClipboard.js +2 -2
  168. package/dist/esm/hooks/useCounter/useCounter.js +2 -2
  169. package/dist/esm/hooks/useCounter/useCounter.js.map +1 -1
  170. package/dist/esm/hooks/useCssVar/useCssVar.js +2 -2
  171. package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  172. package/dist/esm/hooks/useDebounceValue/useDebounceValue.js +2 -2
  173. package/dist/esm/hooks/useDefault/useDefault.js +2 -2
  174. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js +3 -0
  175. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -0
  176. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js +3 -0
  177. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -0
  178. package/dist/esm/hooks/useDidUpdate/useDidUpdate.js +1 -1
  179. package/dist/esm/hooks/useDisclosure/useDisclosure.js +2 -2
  180. package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  181. package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  182. package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  183. package/dist/esm/hooks/useEvent/useEvent.js +1 -1
  184. package/dist/esm/hooks/useEventListener/useEventListener.js +2 -2
  185. package/dist/esm/hooks/useEventListener/useEventListener.js.map +1 -1
  186. package/dist/esm/hooks/useEyeDropper/useEyeDropper.js +2 -2
  187. package/dist/esm/hooks/useFavicon/useFavicon.js +2 -2
  188. package/dist/esm/hooks/useField/useField.js +2 -2
  189. package/dist/esm/hooks/useField/useField.js.map +1 -1
  190. package/dist/esm/hooks/useFileDialog/useFileDialog.js +2 -2
  191. package/dist/esm/hooks/useFileDialog/useFileDialog.js.map +1 -1
  192. package/dist/esm/hooks/useFps/useFps.js +2 -2
  193. package/dist/esm/hooks/useFps/useFps.js.map +1 -1
  194. package/dist/esm/hooks/useFullscreen/useFullscreen.js +2 -2
  195. package/dist/esm/hooks/useFullscreen/useFullscreen.js.map +1 -1
  196. package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +1 -1
  197. package/dist/esm/hooks/useGamepad/useGamepad.js +2 -2
  198. package/dist/esm/hooks/useGeolocation/useGeolocation.js +2 -2
  199. package/dist/esm/hooks/useHash/useHash.js +2 -2
  200. package/dist/esm/hooks/useHotkeys/useHotkeys.js +2 -2
  201. package/dist/esm/hooks/useHotkeys/useHotkeys.js.map +1 -1
  202. package/dist/esm/hooks/useHover/useHover.js +2 -2
  203. package/dist/esm/hooks/useHover/useHover.js.map +1 -1
  204. package/dist/esm/hooks/useIdle/useIdle.js +2 -2
  205. package/dist/esm/hooks/useImage/useImage.js +2 -2
  206. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  207. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.js.map +1 -1
  208. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  209. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.js.map +1 -1
  210. package/dist/esm/hooks/useInterval/useInterval.js +2 -2
  211. package/dist/esm/hooks/useInterval/useInterval.js.map +1 -1
  212. package/dist/esm/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  213. package/dist/esm/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  214. package/dist/esm/hooks/useKeyPress/useKeyPress.js +2 -2
  215. package/dist/esm/hooks/useKeyPress/useKeyPress.js.map +1 -1
  216. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  217. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.js.map +1 -1
  218. package/dist/esm/hooks/useKeyboard/useKeyboard.js +2 -2
  219. package/dist/esm/hooks/useKeyboard/useKeyboard.js.map +1 -1
  220. package/dist/esm/hooks/useKeysPressed/useKeysPressed.js +2 -2
  221. package/dist/esm/hooks/useList/useList.js +2 -2
  222. package/dist/esm/hooks/useLocalStorage/useLocalStorage.js +2 -2
  223. package/dist/esm/hooks/useLogger/useLogger.js +2 -2
  224. package/dist/esm/hooks/useLongPress/useLongPress.js +2 -2
  225. package/dist/esm/hooks/useMap/useMap.js +2 -2
  226. package/dist/esm/hooks/useMeasure/useMeasure.js +2 -2
  227. package/dist/esm/hooks/useMeasure/useMeasure.js.map +1 -1
  228. package/dist/esm/hooks/useMediaQuery/useMediaQuery.js +1 -1
  229. package/dist/esm/hooks/useMemory/useMemory.js +2 -2
  230. package/dist/esm/hooks/useMount/useMount.js +1 -1
  231. package/dist/esm/hooks/useMouse/useMouse.js +2 -2
  232. package/dist/esm/hooks/useMouse/useMouse.js.map +1 -1
  233. package/dist/esm/hooks/useMutation/useMutation.js +2 -2
  234. package/dist/esm/hooks/useMutation/useMutation.js.map +1 -1
  235. package/dist/esm/hooks/useMutationObserver/useMutationObserver.js +2 -2
  236. package/dist/esm/hooks/useMutationObserver/useMutationObserver.js.map +1 -1
  237. package/dist/esm/hooks/useNetwork/useNetwork.js +2 -2
  238. package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  239. package/dist/esm/hooks/useOnline/useOnline.js +1 -1
  240. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.js +2 -2
  241. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.js.map +1 -1
  242. package/dist/esm/hooks/useOptimistic/useOptimistic.js +3 -0
  243. package/dist/esm/hooks/useOptimistic/useOptimistic.js.map +1 -0
  244. package/dist/esm/hooks/useOrientation/useOrientation.js +2 -2
  245. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js +2 -2
  246. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  247. package/dist/esm/hooks/usePageLeave/usePageLeave.js +2 -2
  248. package/dist/esm/hooks/usePaint/helpers/Paint.js +2 -2
  249. package/dist/esm/hooks/usePaint/helpers/Pointer.js +2 -2
  250. package/dist/esm/hooks/usePaint/usePaint.js +2 -2
  251. package/dist/esm/hooks/usePaint/usePaint.js.map +1 -1
  252. package/dist/esm/hooks/useParallax/useParallax.js +3 -0
  253. package/dist/esm/hooks/useParallax/useParallax.js.map +1 -0
  254. package/dist/esm/hooks/usePermission/usePermission.js +2 -2
  255. package/dist/esm/hooks/usePermission/usePermission.js.map +1 -1
  256. package/dist/esm/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  257. package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  258. package/dist/esm/hooks/usePreferredDark/usePreferredDark.js +1 -1
  259. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  260. package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  261. package/dist/esm/hooks/usePrevious/usePrevious.js +1 -1
  262. package/dist/esm/hooks/useQuery/useQuery.js +2 -2
  263. package/dist/esm/hooks/useQuery/useQuery.js.map +1 -1
  264. package/dist/esm/hooks/useQueue/useQueue.js +2 -2
  265. package/dist/esm/hooks/useRaf/useRaf.js +2 -2
  266. package/dist/esm/hooks/useRaf/useRaf.js.map +1 -1
  267. package/dist/esm/hooks/useRafValue/useRafValue.js +2 -2
  268. package/dist/esm/hooks/useRenderCount/useRenderCount.js +1 -1
  269. package/dist/esm/hooks/useRenderInfo/useRenderInfo.js +1 -1
  270. package/dist/esm/hooks/useRerender/useRerender.js +2 -2
  271. package/dist/esm/hooks/useRerender/useRerender.js.map +1 -1
  272. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js +2 -2
  273. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  274. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js +3 -0
  275. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -0
  276. package/dist/esm/hooks/useScript/useScript.js +2 -2
  277. package/dist/esm/hooks/useSessionStorage/useSessionStorage.js +2 -2
  278. package/dist/esm/hooks/useSet/useSet.js +2 -2
  279. package/dist/esm/hooks/useSet/useSet.js.map +1 -1
  280. package/dist/esm/hooks/useShare/useShare.js +2 -2
  281. package/dist/esm/hooks/useStep/useStep.js +2 -2
  282. package/dist/esm/hooks/useStopwatch/useStopwatch.js +2 -2
  283. package/dist/esm/hooks/useStopwatch/useStopwatch.js.map +1 -1
  284. package/dist/esm/hooks/useStorage/useStorage.js +2 -2
  285. package/dist/esm/hooks/useStorage/useStorage.js.map +1 -1
  286. package/dist/esm/hooks/useTextSelection/useTextSelection.js +2 -2
  287. package/dist/esm/hooks/useTime/useTime.js +2 -2
  288. package/dist/esm/hooks/useTimeout/useTimeout.js +2 -2
  289. package/dist/esm/hooks/useToggle/useToggle.js +2 -2
  290. package/dist/esm/hooks/useUnmount/useUnmount.js +1 -1
  291. package/dist/esm/hooks/useWebSocket/useWebSocket.js +2 -2
  292. package/dist/esm/hooks/useWindowEvent/useWindowEvent.js +2 -2
  293. package/dist/esm/hooks/useWindowScroll/useWindowScroll.js +2 -2
  294. package/dist/esm/hooks/useWindowScroll/useWindowScroll.js.map +1 -1
  295. package/dist/esm/hooks/useWindowSize/useWindowSize.js +2 -2
  296. package/dist/esm/hooks/useWizard/useWizard.js +2 -2
  297. package/dist/esm/{index-BPVyLfoe.js → index-CNvEQA9K.js} +2 -2
  298. package/dist/esm/{index-BPVyLfoe.js.map → index-CNvEQA9K.js.map} +1 -1
  299. package/dist/esm/index.js +2 -2
  300. package/dist/esm/utils/helpers/debounce.js +1 -1
  301. package/dist/esm/utils/helpers/getElement.js +1 -1
  302. package/dist/esm/utils/helpers/getRetry.js +1 -1
  303. package/dist/esm/utils/helpers/index.js +1 -1
  304. package/dist/esm/utils/helpers/isClient.js +1 -1
  305. package/dist/esm/utils/helpers/throttle.js +1 -1
  306. package/dist/esm/utils/helpers/throttle.js.map +1 -1
  307. package/dist/esm/utils/helpers/time/getDate.js +1 -1
  308. package/dist/index.d.ts +160 -59
  309. package/package.json +98 -99
  310. package/dist/cjs/_rollupPluginBabelHelpers-CpK-EpSH.js +0 -3
  311. package/dist/cjs/_rollupPluginBabelHelpers-CpK-EpSH.js.map +0 -1
  312. package/dist/esm/_rollupPluginBabelHelpers-B91Ylx3P.js +0 -3
  313. package/dist/esm/_rollupPluginBabelHelpers-B91Ylx3P.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -220,10 +220,10 @@ declare const useBrowserLanguage: () => string;
220
220
 
221
221
  /** The use click outside target element type */
222
222
  type UseClickOutsideTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
223
- type UseClickOutside = {
223
+ interface UseClickOutside {
224
224
  <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(target: Target, callback: (event: Event) => void): void;
225
225
  <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): (node: Target) => void;
226
- };
226
+ }
227
227
  /**
228
228
  * @name useClickOutside
229
229
  * @description - Hook to handle click events outside the specified target element(s)
@@ -297,12 +297,12 @@ interface UseCounterReturn {
297
297
  /** Function to decrement the counter */
298
298
  dec: (value?: number) => void;
299
299
  }
300
- type UseCounter = {
300
+ interface UseCounter {
301
301
  (initialValue?: number, options?: UseCounterOptions): UseCounterReturn;
302
302
  (options: UseCounterOptions & {
303
303
  initialValue?: number;
304
304
  }, initialValue?: never): UseCounterReturn;
305
- };
305
+ }
306
306
  /**
307
307
  * @name useCounter
308
308
  * @description - Hook that manages a counter with increment, decrement, reset, and set functionalities
@@ -412,6 +412,63 @@ declare const useDebounceValue: <Value>(value: Value, delay: number) => Value;
412
412
  */
413
413
  declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultValue: Value) => readonly [Value, react.Dispatch<react.SetStateAction<Value | null | undefined>>];
414
414
 
415
+ interface UseDeviceMotionReturn {
416
+ interval: DeviceMotionEvent['interval'];
417
+ acceleration: DeviceMotionEventAcceleration;
418
+ accelerationIncludingGravity: DeviceMotionEventAcceleration;
419
+ rotationRate: DeviceMotionEventRotationRate;
420
+ }
421
+ interface UseDeviceMotionParams {
422
+ /** The delay in milliseconds */
423
+ delay?: number;
424
+ /** The callback function to be invoked */
425
+ callback?: (event: DeviceMotionEvent) => void;
426
+ /** Whether to enable the hook */
427
+ enabled?: boolean;
428
+ }
429
+ /**
430
+ * @name useDeviceMotion
431
+ * @description Hook that work with device motion
432
+ * @category Utilities
433
+ *
434
+ * @param {number} [delay=1000] The delay in milliseconds
435
+ * @param {(event: DeviceMotionEvent) => void} [callback] The callback function to be invoked
436
+ * @param {boolean} [enabled=true] Whether to enable the hook
437
+ * @returns {UseDeviceMotionReturn} The device motion data and interval
438
+ *
439
+ * @example
440
+ * const { interval, rotationRate, acceleration, accelerationIncludingGravity } = useDeviceMotion();
441
+ */
442
+ declare const useDeviceMotion: (params?: UseDeviceMotionParams) => UseDeviceMotionReturn;
443
+
444
+ interface UseDeviceOrientationValue {
445
+ /** A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 to 360 */
446
+ alpha: number | null;
447
+ /** A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 to 180 */
448
+ beta: number | null;
449
+ /** A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 to 90 */
450
+ gamma: number | null;
451
+ /** The current absolute value */
452
+ absolute: boolean;
453
+ }
454
+ interface UseDeviceOrientationReturn {
455
+ /** Whether the device orientation is supported */
456
+ supported: boolean;
457
+ /** The current device orientation value */
458
+ value: UseDeviceOrientationValue;
459
+ }
460
+ /**
461
+ * @name useDeviceOrientation
462
+ * @description - Hook that provides the current device orientation
463
+ * @category Sensors
464
+ *
465
+ * @returns {UseDeviceOrientationReturn} The current device orientation
466
+ *
467
+ * @example
468
+ * const { supported, value } = useDeviceOrientation();
469
+ */
470
+ declare const useDeviceOrientation: () => UseDeviceOrientationReturn;
471
+
415
472
  /**
416
473
  * @name useDidUpdate
417
474
  * @description – Hook that behaves like useEffect, but skips the effect on the initial render
@@ -461,13 +518,13 @@ declare const useDisclosure: (initialValue?: boolean, options?: UseDisclosureOpt
461
518
  type UseEventListenerTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
462
519
  type UseEventListenerOptions = boolean | AddEventListenerOptions;
463
520
  type UseEventListenerReturn<Target extends UseEventListenerTarget> = RefObject<Target>;
464
- type UseEventListener = {
521
+ interface UseEventListener {
465
522
  <Event extends keyof WindowEventMap = keyof WindowEventMap>(target: Window, event: Event | Event[], listener: (this: Window, event: WindowEventMap[Event]) => void, options?: UseEventListenerOptions): void;
466
523
  <Event extends keyof DocumentEventMap = keyof DocumentEventMap>(target: Document, event: Event | Event[], listener: (this: Document, event: DocumentEventMap[Event]) => void, options?: UseEventListenerOptions): void;
467
524
  <Target extends UseEventListenerTarget, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(target: Target, event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions): void;
468
525
  <Target extends Element, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
469
526
  <Target extends Element, Event extends keyof MediaQueryListEventMap = keyof MediaQueryListEventMap>(event: Event | Event[], listener: (this: Target, event: MediaQueryListEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
470
- };
527
+ }
471
528
  declare const useEventListener: UseEventListener;
472
529
 
473
530
  /**
@@ -706,10 +763,10 @@ interface UseFileDialogReturn {
706
763
  /** The reset function */
707
764
  reset: () => void;
708
765
  }
709
- type UseFileDialog = {
766
+ interface UseFileDialog {
710
767
  (callback?: (value: FileList | null) => void, options?: UseFileDialogOptions): UseFileDialogReturn;
711
768
  (options?: UseFileDialogOptions, callback?: never): UseFileDialogReturn;
712
- };
769
+ }
713
770
  /**
714
771
  * @name useFileDialog
715
772
  * @description - Hook to handle file input
@@ -768,12 +825,12 @@ interface UseFullScreenReturn {
768
825
  toggle: () => void;
769
826
  value: boolean;
770
827
  }
771
- type UseFullScreen = {
828
+ interface UseFullScreen {
772
829
  <Target extends UseFullScreenTarget>(target: Target, options?: UseFullScreenOptions): UseFullScreenReturn;
773
830
  <Target extends UseFullScreenTarget>(options?: UseFullScreenOptions, target?: never): UseFullScreenReturn & {
774
831
  ref: (node: Target) => void;
775
832
  };
776
- };
833
+ }
777
834
  /**
778
835
  * @name useFullscreen
779
836
  * @description - Hook to handle fullscreen events
@@ -936,11 +993,11 @@ interface UseHotkeysOptions {
936
993
  }
937
994
  declare const isHotkeyMatch: (hotkey: string, keys: UseHotkeysKey[]) => boolean;
938
995
  type UseHotkeysHotkeys = string[] | string;
939
- type UseHotkeysKey = {
996
+ interface UseHotkeysKey {
940
997
  key: string;
941
998
  code: string;
942
999
  alias: string;
943
- };
1000
+ }
944
1001
  /**
945
1002
  * @name useHotkeys
946
1003
  * @description - Hook that listens for hotkeys
@@ -967,12 +1024,12 @@ interface UseHoverOptions {
967
1024
  onLeave?: () => void;
968
1025
  }
969
1026
  type UseHoverTarget = RefObject<Element | null | undefined> | Element;
970
- type UseHover = {
1027
+ interface UseHover {
971
1028
  <Target extends UseHoverTarget>(target: Target, callback?: () => void): boolean;
972
1029
  <Target extends UseHoverTarget>(target: Target, options?: UseHoverOptions): boolean;
973
1030
  <Target extends UseHoverTarget>(callback?: () => void, target?: never): [RefObject<Target>, boolean];
974
1031
  <Target extends UseHoverTarget>(options?: UseHoverOptions, target?: never): [RefObject<Target>, boolean];
975
- };
1032
+ }
976
1033
  /**
977
1034
  * @name useHover
978
1035
  * @description - Hook that defines the logic when hovering an element
@@ -1146,13 +1203,13 @@ interface UseInfiniteScrollOptions {
1146
1203
  /** The direction to trigger the callback */
1147
1204
  direction?: 'top' | 'bottom' | 'left' | 'right';
1148
1205
  }
1149
- type UseInfiniteScroll = {
1206
+ interface UseInfiniteScroll {
1150
1207
  <Target extends UseInfiniteScrollTarget>(target: Target, callback: (event: Event) => void, options?: UseInfiniteScrollOptions): boolean;
1151
1208
  <Target extends UseInfiniteScrollTarget>(callback: (event: Event) => void, options?: UseInfiniteScrollOptions, target?: never): {
1152
1209
  ref: (node: Target) => void;
1153
1210
  isLoading: boolean;
1154
1211
  };
1155
- };
1212
+ }
1156
1213
  /**
1157
1214
  * @name useInfiniteScroll
1158
1215
  * @description - Hook that defines the logic for infinite scroll
@@ -1194,12 +1251,12 @@ interface UseIntersectionObserverReturn {
1194
1251
  inView: boolean;
1195
1252
  entry?: IntersectionObserverEntry;
1196
1253
  }
1197
- type UseIntersectionObserver = {
1254
+ interface UseIntersectionObserver {
1198
1255
  <Target extends UseIntersectionObserverTarget>(target: Target, options?: UseIntersectionObserverOptions): UseIntersectionObserverReturn;
1199
1256
  <Target extends UseIntersectionObserverTarget>(options?: UseIntersectionObserverOptions, target?: never): UseIntersectionObserverReturn & {
1200
1257
  ref: (node: Target) => void;
1201
1258
  };
1202
- };
1259
+ }
1203
1260
  /**
1204
1261
  * @name useIntersectionObserver
1205
1262
  * @description - Hook that gives you intersection observer state
@@ -1242,12 +1299,12 @@ interface UseIntervalReturn {
1242
1299
  /** Resume the interval */
1243
1300
  resume: () => void;
1244
1301
  }
1245
- type UseInterval = {
1302
+ interface UseInterval {
1246
1303
  (callback: () => void, interval?: number, options?: UseIntervalOptions): UseIntervalReturn;
1247
1304
  (callback: () => void, options?: UseIntervalOptions & {
1248
1305
  interval?: number;
1249
1306
  }): UseIntervalReturn;
1250
- };
1307
+ }
1251
1308
  /**
1252
1309
  * @name useInterval
1253
1310
  * @description - Hook that makes and interval and returns controlling functions
@@ -1295,14 +1352,14 @@ declare const useIsFirstRender: () => boolean;
1295
1352
  declare const useIsomorphicLayoutEffect: typeof useEffect;
1296
1353
 
1297
1354
  /** The use key press options type */
1298
- type UseKeyboardParams = {
1355
+ interface UseKeyboardParams {
1299
1356
  /** The target to attach the event listeners to */
1300
1357
  target?: UseEventListenerTarget;
1301
1358
  /** The callback function to be invoked on key down */
1302
1359
  onKeyDown?: (event: KeyboardEvent) => void;
1303
1360
  /** The callback function to be invoked on key up */
1304
1361
  onKeyUp?: (event: KeyboardEvent) => void;
1305
- };
1362
+ }
1306
1363
  /**
1307
1364
  * @name useKeyboard
1308
1365
  * @description - Hook that help to listen for keyboard events
@@ -1320,10 +1377,10 @@ declare const useKeyboard: (params?: UseKeyboardParams) => void;
1320
1377
  /** The key or keys to listen for */
1321
1378
  type UseKeyPressKey = string | string[];
1322
1379
  /** The use key press options type */
1323
- type UseKeyPressOptions = {
1380
+ interface UseKeyPressOptions {
1324
1381
  /** The target to attach the event listeners to */
1325
1382
  target?: UseEventListenerTarget;
1326
- };
1383
+ }
1327
1384
  /**
1328
1385
  * @name useKeyPress
1329
1386
  * @description - Hook that listens for key press events
@@ -1339,12 +1396,12 @@ type UseKeyPressOptions = {
1339
1396
  declare const useKeyPress: (key: UseKeyPressKey, options?: UseKeyPressOptions) => boolean;
1340
1397
 
1341
1398
  type UseKeyPressEventKey = string | string[];
1342
- type UseKeyPressEvent = {
1399
+ interface UseKeyPressEvent {
1343
1400
  (key: UseKeyPressEventKey, target: Window, listener: (this: Window, event: WindowEventMap['keydown']) => void, options?: UseEventListenerOptions): void;
1344
1401
  (key: UseKeyPressEventKey, target: Document, listener: (this: Document, event: DocumentEventMap['keydown']) => void, options?: UseEventListenerOptions): void;
1345
1402
  <Target extends UseEventListenerTarget>(key: UseKeyPressEventKey, target: Target, listener: (this: Target, event: HTMLElementEventMap['keydown']) => void, options?: UseEventListenerOptions): void;
1346
1403
  <Target extends Element>(key: UseKeyPressEventKey, listener: (this: Target, event: HTMLElementEventMap['keydown']) => void, options?: UseEventListenerOptions, target?: never): void;
1347
- };
1404
+ }
1348
1405
  declare const useKeyPressEvent: UseKeyPressEvent;
1349
1406
 
1350
1407
  /** The use keys pressed params type */
@@ -1418,11 +1475,11 @@ interface UseStorageOptions<Value> {
1418
1475
  storage?: Storage;
1419
1476
  initialValue?: UseStorageInitialValue<Value>;
1420
1477
  }
1421
- type UseStorageReturn<Value> = {
1478
+ interface UseStorageReturn<Value> {
1422
1479
  value: Value;
1423
1480
  set: (value: Value) => void;
1424
1481
  remove: () => void;
1425
- };
1482
+ }
1426
1483
  declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => boolean;
1427
1484
  /**
1428
1485
  * @name useStorage
@@ -1550,12 +1607,12 @@ declare const useMap: <Key, Value>(values?: [Key, Value][]) => UseMapReturn<Key,
1550
1607
  type UseMeasureTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
1551
1608
  /** The use measure return type */
1552
1609
  type UseMeasureReturn = Pick<DOMRectReadOnly, 'x' | 'y' | 'top' | 'left' | 'right' | 'bottom' | 'height' | 'width'>;
1553
- type UseMeasureScreen = {
1610
+ interface UseMeasureScreen {
1554
1611
  <Target extends UseMeasureTarget>(target: Target): UseMeasureReturn;
1555
1612
  <Target extends UseMeasureTarget>(target?: never): UseMeasureReturn & {
1556
1613
  ref: RefObject<Target>;
1557
1614
  };
1558
- };
1615
+ }
1559
1616
  /**
1560
1617
  * @name useMeasure
1561
1618
  * @description - Hook to measure the size and position of an element
@@ -1639,6 +1696,8 @@ interface UseMouseReturn {
1639
1696
  x: number;
1640
1697
  /** The current mouse y position */
1641
1698
  y: number;
1699
+ /** The current element */
1700
+ element: Element;
1642
1701
  /** The current element x position */
1643
1702
  elementX: number;
1644
1703
  /** The current element y position */
@@ -1648,12 +1707,12 @@ interface UseMouseReturn {
1648
1707
  /** The current element position y */
1649
1708
  elementPositionY: number;
1650
1709
  }
1651
- type UseMouse = {
1710
+ interface UseMouse {
1652
1711
  <Target extends UseMouseTarget>(target: Target): UseMouseReturn;
1653
1712
  <Target extends UseMouseTarget>(target?: never): UseMouseReturn & {
1654
1713
  ref: (node: Target) => void;
1655
1714
  };
1656
- };
1715
+ }
1657
1716
  /**
1658
1717
  * @name useMouse
1659
1718
  * @description - Hook that manages a mouse position
@@ -1685,8 +1744,8 @@ interface UseMutationOptions<Data> {
1685
1744
  interface UseMutationReturn<Body, Data> {
1686
1745
  data: Data | null;
1687
1746
  error: Error | null;
1688
- mutate: (body: Body, options?: UseMutationOptions<Data>) => void;
1689
- mutateAsync: (body: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
1747
+ mutate: (body?: Body, options?: UseMutationOptions<Data>) => void;
1748
+ mutateAsync: (body?: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
1690
1749
  isLoading: boolean;
1691
1750
  isError: boolean;
1692
1751
  isSuccess: boolean;
@@ -1726,12 +1785,12 @@ interface UseMutationObserverOptions extends MutationObserverInit {
1726
1785
  /** The enabled state of the mutation observer */
1727
1786
  enabled?: boolean;
1728
1787
  }
1729
- type UseMutationObserver = {
1788
+ interface UseMutationObserver {
1730
1789
  <Target extends UseMutationObserverTarget | UseMutationObserverTarget[]>(target: Target, callback: MutationCallback, options?: UseMutationObserverOptions): UseMutationObserverReturn;
1731
1790
  <Target extends UseMutationObserverTarget | UseMutationObserverTarget[]>(callback: MutationCallback, options?: UseMutationObserverOptions, target?: never): UseMutationObserverReturn & {
1732
1791
  ref: (node: Target) => void;
1733
1792
  };
1734
- };
1793
+ }
1735
1794
  /**
1736
1795
  * @name useMutationObserver
1737
1796
  * @description - Hook that gives you mutation observer state
@@ -1918,6 +1977,25 @@ declare const getOperatingSystem: () => OperatingSystem;
1918
1977
  */
1919
1978
  declare const useOperatingSystem: () => OperatingSystem;
1920
1979
 
1980
+ type UseOptimisticReturn<State> = [
1981
+ State,
1982
+ (optimisticValue: State, promise: Promise<any>) => void
1983
+ ];
1984
+ /**
1985
+ * @name useOptimistic
1986
+ * @description - Hook that allows get optimistic value before its update
1987
+ * @category Utilities
1988
+ *
1989
+ * @template State The type of the state
1990
+ * @param {State} state The value to be returned initially and whenever no action is pending
1991
+ * @param {(currentState: State, optimisticValue: State) => State} update A pure function that takes the current state and the optimistic value passed to updateOptimistic and returns the resulting optimistic state
1992
+ * @returns {UseOptimisticReturn<State>} The resulting optimistic state, and the function to update it
1993
+ *
1994
+ * @example
1995
+ * const [optimisticValue, updateOptimistic] = useOptimistic<number>(count, (currentState, optimisticValue) => currentState + optimisticValue);
1996
+ */
1997
+ declare const useOptimistic: <State, OptimisticState = State>(externalState: State, update: (currentState: State, optimisticState: OptimisticState) => State) => readonly [State, (optimisticValue: OptimisticState, promise: Promise<any>) => Promise<any>];
1998
+
1921
1999
  /** The use orientation return type */
1922
2000
  interface UseOrientationReturn {
1923
2001
  /** The current screen orientation angle */
@@ -1959,10 +2037,10 @@ interface UseOtpCredentialReturn {
1959
2037
  abort: AbortController['abort'];
1960
2038
  aborted: boolean;
1961
2039
  }
1962
- type UseOtpCredential = {
2040
+ interface UseOtpCredential {
1963
2041
  (callback?: UseOtpCredentialCallback): UseOtpCredentialReturn;
1964
2042
  (params?: UseOtpCredentialParams): UseOtpCredentialReturn;
1965
- };
2043
+ }
1966
2044
  /**
1967
2045
  * @name useOtpCredential
1968
2046
  * @description - Hook that creates an otp credential
@@ -2070,12 +2148,12 @@ interface UsePaintReturn {
2070
2148
  }
2071
2149
  /** The use paint return type */
2072
2150
  type UsePaintTarget = RefObject<HTMLCanvasElement> | (() => HTMLCanvasElement) | HTMLCanvasElement;
2073
- type UsePaint = {
2151
+ interface UsePaint {
2074
2152
  <Target extends UsePaintTarget>(target: Target, options?: UsePaintOptions): UsePaintReturn;
2075
2153
  (options?: UsePaintOptions, target?: never): {
2076
2154
  ref: RefObject<HTMLCanvasElement>;
2077
2155
  } & UsePaintReturn;
2078
- };
2156
+ }
2079
2157
  /**
2080
2158
  * @name usePaint
2081
2159
  * @description - Hook that allows you to draw in a specific area
@@ -2348,12 +2426,12 @@ interface UseResizeObserverOptions extends ResizeObserverOptions {
2348
2426
  interface UseResizeObserverReturn {
2349
2427
  entries: ResizeObserverEntry[];
2350
2428
  }
2351
- type UseResizeObserver = {
2429
+ interface UseResizeObserver {
2352
2430
  <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(target: Target, options?: UseResizeObserverOptions): UseResizeObserverReturn;
2353
2431
  <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
2354
2432
  ref: (node: Target) => void;
2355
2433
  };
2356
- };
2434
+ }
2357
2435
  /**
2358
2436
  * @name useResizeObserver
2359
2437
  * @description - Hook that gives you resize observer state
@@ -2382,6 +2460,40 @@ type UseResizeObserver = {
2382
2460
  */
2383
2461
  declare const useResizeObserver: UseResizeObserver;
2384
2462
 
2463
+ declare global {
2464
+ interface ScreenOrientation {
2465
+ lock: (orientation: OrientationLockType) => Promise<void>;
2466
+ }
2467
+ }
2468
+ interface UseScreenOrientationValue {
2469
+ /** The current angle */
2470
+ angle: number;
2471
+ /** The current orientation type */
2472
+ orientationType: OrientationType;
2473
+ }
2474
+ type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
2475
+ interface useScreenOrientationReturn {
2476
+ /** Whether the screen orientation is supported */
2477
+ supported: boolean;
2478
+ /** The current screen orientation value */
2479
+ value: UseScreenOrientationValue;
2480
+ /** Lock the screen orientation */
2481
+ lock: (orientation: OrientationLockType) => void;
2482
+ /** Unlock the screen orientation */
2483
+ unlock: () => void;
2484
+ }
2485
+ /**
2486
+ * @name useScreenOrientation
2487
+ * @description - Hook that provides the current screen orientation
2488
+ * @category Sensors
2489
+ *
2490
+ * @returns {useScreenOrientationReturn} The current screen orientation
2491
+ *
2492
+ * @example
2493
+ * const { supported, value, lock, unlock } = useScreenOrientation();
2494
+ */
2495
+ declare const useScreenOrientation: () => useScreenOrientationReturn;
2496
+
2385
2497
  /** The use script status */
2386
2498
  type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
2387
2499
  declare const SCRIPT_STATUS_ATTRIBUTE_NAME = "script-status";
@@ -2425,17 +2537,6 @@ declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageI
2425
2537
  remove: () => void;
2426
2538
  };
2427
2539
 
2428
- declare global {
2429
- interface Set<T> {
2430
- union(other: Set<T>): Set<T>;
2431
- difference(other: Set<T>): Set<T>;
2432
- symmetricDifference(other: Set<T>): Set<T>;
2433
- intersection(other: Set<T>): Set<T>;
2434
- isDisjointFrom(other: Set<T>): boolean;
2435
- isSubsetOf(other: Set<T>): boolean;
2436
- isSupersetOf(other: Set<T>): boolean;
2437
- }
2438
- }
2439
2540
  /** The use set return type */
2440
2541
  interface UseSetReturn<Value> {
2441
2542
  /** The current set */
@@ -2589,12 +2690,12 @@ interface UseStopwatchOptions {
2589
2690
  /** The enabled state of the timer */
2590
2691
  enabled?: boolean;
2591
2692
  }
2592
- type UseStopwatch = {
2693
+ interface UseStopwatch {
2593
2694
  (initialTime?: number, options?: UseStopwatchOptions): UseStopwatchReturn;
2594
2695
  (options?: UseStopwatchOptions & {
2595
2696
  initialTime?: number;
2596
2697
  }): UseStopwatchReturn;
2597
- };
2698
+ }
2598
2699
  /**
2599
2700
  * @name useStopwatch
2600
2701
  * @description - Hook that creates a stopwatch functionality
@@ -2771,10 +2872,10 @@ declare const useWebSocket: (url: UseWebSocketUrl, options?: UseWebSocketOptions
2771
2872
  */
2772
2873
  declare const useWindowEvent: <Event extends keyof WindowEventMap>(event: Event, listener: (this: Window, event: WindowEventMap[Event]) => any, options?: UseEventListenerOptions) => void;
2773
2874
 
2774
- type ScrollPosition = {
2875
+ interface ScrollPosition {
2775
2876
  x: number;
2776
2877
  y: number;
2777
- };
2878
+ }
2778
2879
  declare const scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & ScrollOptions>) => void;
2779
2880
  /**
2780
2881
  * @name useWindowScroll
@@ -2785,7 +2886,7 @@ declare const scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & ScrollOpti
2785
2886
  *
2786
2887
  * @example
2787
2888
  * const { value, scrollTo } = useWindowScroll();
2788
- * */
2889
+ */
2789
2890
  declare const useWindowScroll: () => {
2790
2891
  value: ScrollPosition;
2791
2892
  scrollTo: ({ x, y, behavior }: Partial<ScrollPosition & ScrollOptions>) => void;
@@ -2873,4 +2974,4 @@ declare const getDate: (now?: Date) => {
2873
2974
  timestamp: number;
2874
2975
  };
2875
2976
 
2876
- export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type UseAsyncReturn, type UseBatteryStateReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UsePermissionName, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOrientation, useOtpCredential, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };
2977
+ export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type UseAsyncReturn, type UseBatteryStateReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UsePermissionName, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };