@siberiacancode/reactuse 0.0.71 → 0.0.73

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 (449) hide show
  1. package/dist/cjs/_rollupPluginBabelHelpers-BHOoWWtW.js +3 -0
  2. package/dist/cjs/_rollupPluginBabelHelpers-BHOoWWtW.js.map +1 -0
  3. package/dist/cjs/hooks/index.js +2 -2
  4. package/dist/cjs/hooks/useActiveElement/useActiveElement.js +3 -0
  5. package/dist/cjs/hooks/useActiveElement/useActiveElement.js.map +1 -0
  6. package/dist/cjs/hooks/useAsync/useAsync.js +2 -2
  7. package/dist/cjs/hooks/useAsync/useAsync.js.map +1 -1
  8. package/dist/cjs/hooks/useBattery/useBattery.js +2 -2
  9. package/dist/cjs/hooks/useBattery/useBattery.js.map +1 -1
  10. package/dist/cjs/hooks/useBoolean/useBoolean.js +2 -2
  11. package/dist/cjs/hooks/useBoolean/useBoolean.js.map +1 -1
  12. package/dist/cjs/hooks/useBreakpoints/constants/breakpoints.js +1 -1
  13. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.js +2 -2
  14. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.js.map +1 -1
  15. package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  16. package/dist/cjs/hooks/useClickOutside/useClickOutside.js +2 -2
  17. package/dist/cjs/hooks/useClickOutside/useClickOutside.js.map +1 -1
  18. package/dist/cjs/hooks/useClipboard/useClipboard.js +2 -2
  19. package/dist/cjs/hooks/useClipboard/useClipboard.js.map +1 -1
  20. package/dist/cjs/hooks/useCounter/useCounter.js +2 -2
  21. package/dist/cjs/hooks/useCounter/useCounter.js.map +1 -1
  22. package/dist/cjs/hooks/useCssVar/useCssVar.js +2 -2
  23. package/dist/cjs/hooks/useCssVar/useCssVar.js.map +1 -1
  24. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  25. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.js.map +1 -1
  26. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.js +2 -2
  27. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.js.map +1 -1
  28. package/dist/cjs/hooks/useDefault/useDefault.js +2 -2
  29. package/dist/cjs/hooks/useDefault/useDefault.js.map +1 -1
  30. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js +2 -2
  31. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -1
  32. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js +2 -2
  33. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -1
  34. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.js +1 -1
  35. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.js.map +1 -1
  36. package/dist/cjs/hooks/useDisclosure/useDisclosure.js +2 -2
  37. package/dist/cjs/hooks/useDisclosure/useDisclosure.js.map +1 -1
  38. package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  39. package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.js.map +1 -1
  40. package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  41. package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.js.map +1 -1
  42. package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  43. package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.js.map +1 -1
  44. package/dist/cjs/hooks/useEvent/useEvent.js +1 -1
  45. package/dist/cjs/hooks/useEvent/useEvent.js.map +1 -1
  46. package/dist/cjs/hooks/useEventListener/useEventListener.js +2 -2
  47. package/dist/cjs/hooks/useEventListener/useEventListener.js.map +1 -1
  48. package/dist/cjs/hooks/useEyeDropper/useEyeDropper.js +2 -2
  49. package/dist/cjs/hooks/useEyeDropper/useEyeDropper.js.map +1 -1
  50. package/dist/cjs/hooks/useFavicon/useFavicon.js +2 -2
  51. package/dist/cjs/hooks/useFavicon/useFavicon.js.map +1 -1
  52. package/dist/cjs/hooks/useField/useField.js +2 -2
  53. package/dist/cjs/hooks/useField/useField.js.map +1 -1
  54. package/dist/cjs/hooks/useFileDialog/useFileDialog.js +2 -2
  55. package/dist/cjs/hooks/useFileDialog/useFileDialog.js.map +1 -1
  56. package/dist/cjs/hooks/useFocus/useFocus.js +2 -2
  57. package/dist/cjs/hooks/useFocus/useFocus.js.map +1 -1
  58. package/dist/cjs/hooks/useFps/useFps.js +2 -2
  59. package/dist/cjs/hooks/useFps/useFps.js.map +1 -1
  60. package/dist/cjs/hooks/useFullscreen/useFullscreen.js +2 -2
  61. package/dist/cjs/hooks/useFullscreen/useFullscreen.js.map +1 -1
  62. package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +1 -1
  63. package/dist/cjs/hooks/useGamepad/useGamepad.js +2 -2
  64. package/dist/cjs/hooks/useGamepad/useGamepad.js.map +1 -1
  65. package/dist/cjs/hooks/useGeolocation/useGeolocation.js +2 -2
  66. package/dist/cjs/hooks/useGeolocation/useGeolocation.js.map +1 -1
  67. package/dist/cjs/hooks/useHash/useHash.js +2 -2
  68. package/dist/cjs/hooks/useHash/useHash.js.map +1 -1
  69. package/dist/cjs/hooks/useHotkeys/useHotkeys.js +2 -2
  70. package/dist/cjs/hooks/useHotkeys/useHotkeys.js.map +1 -1
  71. package/dist/cjs/hooks/useHover/useHover.js +2 -2
  72. package/dist/cjs/hooks/useHover/useHover.js.map +1 -1
  73. package/dist/cjs/hooks/useIdle/useIdle.js +2 -2
  74. package/dist/cjs/hooks/useIdle/useIdle.js.map +1 -1
  75. package/dist/cjs/hooks/useImage/useImage.js +2 -2
  76. package/dist/cjs/hooks/useImage/useImage.js.map +1 -1
  77. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  78. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.js.map +1 -1
  79. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  80. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.js.map +1 -1
  81. package/dist/cjs/hooks/useInterval/useInterval.js +2 -2
  82. package/dist/cjs/hooks/useInterval/useInterval.js.map +1 -1
  83. package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  84. package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.js.map +1 -1
  85. package/dist/cjs/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  86. package/dist/cjs/hooks/useKeyPress/useKeyPress.js +2 -2
  87. package/dist/cjs/hooks/useKeyPress/useKeyPress.js.map +1 -1
  88. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  89. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.js.map +1 -1
  90. package/dist/cjs/hooks/useKeyboard/useKeyboard.js +2 -2
  91. package/dist/cjs/hooks/useKeyboard/useKeyboard.js.map +1 -1
  92. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.js +2 -2
  93. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.js.map +1 -1
  94. package/dist/cjs/hooks/useLastChanged/useLastChanged.js +2 -2
  95. package/dist/cjs/hooks/useLastChanged/useLastChanged.js.map +1 -1
  96. package/dist/cjs/hooks/useList/useList.js +2 -2
  97. package/dist/cjs/hooks/useList/useList.js.map +1 -1
  98. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.js +2 -2
  99. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.js.map +1 -1
  100. package/dist/cjs/hooks/useLogger/useLogger.js +2 -2
  101. package/dist/cjs/hooks/useLongPress/useLongPress.js +2 -2
  102. package/dist/cjs/hooks/useLongPress/useLongPress.js.map +1 -1
  103. package/dist/cjs/hooks/useMap/useMap.js +2 -2
  104. package/dist/cjs/hooks/useMap/useMap.js.map +1 -1
  105. package/dist/cjs/hooks/useMeasure/useMeasure.js +2 -2
  106. package/dist/cjs/hooks/useMeasure/useMeasure.js.map +1 -1
  107. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.js +1 -1
  108. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.js.map +1 -1
  109. package/dist/cjs/hooks/useMemory/useMemory.js +2 -2
  110. package/dist/cjs/hooks/useMount/useMount.js +1 -1
  111. package/dist/cjs/hooks/useMount/useMount.js.map +1 -1
  112. package/dist/cjs/hooks/useMouse/useMouse.js +2 -2
  113. package/dist/cjs/hooks/useMouse/useMouse.js.map +1 -1
  114. package/dist/cjs/hooks/useMutation/useMutation.js +2 -2
  115. package/dist/cjs/hooks/useMutation/useMutation.js.map +1 -1
  116. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.js +2 -2
  117. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.js.map +1 -1
  118. package/dist/cjs/hooks/useNetwork/useNetwork.js +2 -2
  119. package/dist/cjs/hooks/useNetwork/useNetwork.js.map +1 -1
  120. package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  121. package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.js.map +1 -1
  122. package/dist/cjs/hooks/useOnline/useOnline.js +1 -1
  123. package/dist/cjs/hooks/useOnline/useOnline.js.map +1 -1
  124. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.js +1 -1
  125. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.js.map +1 -1
  126. package/dist/cjs/hooks/useOptimistic/useOptimistic.js +2 -2
  127. package/dist/cjs/hooks/useOptimistic/useOptimistic.js.map +1 -1
  128. package/dist/cjs/hooks/useOrientation/useOrientation.js +2 -2
  129. package/dist/cjs/hooks/useOrientation/useOrientation.js.map +1 -1
  130. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js +2 -2
  131. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  132. package/dist/cjs/hooks/usePageLeave/usePageLeave.js +2 -2
  133. package/dist/cjs/hooks/usePageLeave/usePageLeave.js.map +1 -1
  134. package/dist/cjs/hooks/usePaint/helpers/Paint.js +2 -2
  135. package/dist/cjs/hooks/usePaint/helpers/Paint.js.map +1 -1
  136. package/dist/cjs/hooks/usePaint/helpers/Pointer.js +2 -2
  137. package/dist/cjs/hooks/usePaint/helpers/Pointer.js.map +1 -1
  138. package/dist/cjs/hooks/usePaint/usePaint.js +2 -2
  139. package/dist/cjs/hooks/usePaint/usePaint.js.map +1 -1
  140. package/dist/cjs/hooks/useParallax/useParallax.js +2 -2
  141. package/dist/cjs/hooks/useParallax/useParallax.js.map +1 -1
  142. package/dist/cjs/hooks/usePermission/usePermission.js +2 -2
  143. package/dist/cjs/hooks/usePermission/usePermission.js.map +1 -1
  144. package/dist/cjs/hooks/usePointerLock/usePointerLock.js +3 -0
  145. package/dist/cjs/hooks/usePointerLock/usePointerLock.js.map +1 -0
  146. package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  147. package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.js.map +1 -1
  148. package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  149. package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.js.map +1 -1
  150. package/dist/cjs/hooks/usePreferredDark/usePreferredDark.js +1 -1
  151. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  152. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.js.map +1 -1
  153. package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  154. package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js.map +1 -1
  155. package/dist/cjs/hooks/usePrevious/usePrevious.js +1 -1
  156. package/dist/cjs/hooks/useQuery/useQuery.js +2 -2
  157. package/dist/cjs/hooks/useQuery/useQuery.js.map +1 -1
  158. package/dist/cjs/hooks/useQueue/useQueue.js +2 -2
  159. package/dist/cjs/hooks/useQueue/useQueue.js.map +1 -1
  160. package/dist/cjs/hooks/useRaf/useRaf.js +2 -2
  161. package/dist/cjs/hooks/useRaf/useRaf.js.map +1 -1
  162. package/dist/cjs/hooks/useRafValue/useRafValue.js +2 -2
  163. package/dist/cjs/hooks/useRafValue/useRafValue.js.map +1 -1
  164. package/dist/cjs/hooks/useRenderCount/useRenderCount.js +1 -1
  165. package/dist/cjs/hooks/useRenderCount/useRenderCount.js.map +1 -1
  166. package/dist/cjs/hooks/useRenderInfo/useRenderInfo.js +1 -1
  167. package/dist/cjs/hooks/useRenderInfo/useRenderInfo.js.map +1 -1
  168. package/dist/cjs/hooks/useRerender/useRerender.js +2 -2
  169. package/dist/cjs/hooks/useRerender/useRerender.js.map +1 -1
  170. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js +2 -2
  171. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  172. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js +2 -2
  173. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -1
  174. package/dist/cjs/hooks/useScript/useScript.js +2 -2
  175. package/dist/cjs/hooks/useScript/useScript.js.map +1 -1
  176. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.js +2 -2
  177. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.js.map +1 -1
  178. package/dist/cjs/hooks/useSet/useSet.js +2 -2
  179. package/dist/cjs/hooks/useSet/useSet.js.map +1 -1
  180. package/dist/cjs/hooks/useShare/useShare.js +2 -2
  181. package/dist/cjs/hooks/useShare/useShare.js.map +1 -1
  182. package/dist/cjs/hooks/useStep/useStep.js +2 -2
  183. package/dist/cjs/hooks/useStep/useStep.js.map +1 -1
  184. package/dist/cjs/hooks/useStopwatch/useStopwatch.js +2 -2
  185. package/dist/cjs/hooks/useStopwatch/useStopwatch.js.map +1 -1
  186. package/dist/cjs/hooks/useStorage/useStorage.js +2 -2
  187. package/dist/cjs/hooks/useStorage/useStorage.js.map +1 -1
  188. package/dist/cjs/hooks/useTextSelection/useTextSelection.js +2 -2
  189. package/dist/cjs/hooks/useTextSelection/useTextSelection.js.map +1 -1
  190. package/dist/cjs/hooks/useTime/useTime.js +2 -2
  191. package/dist/cjs/hooks/useTime/useTime.js.map +1 -1
  192. package/dist/cjs/hooks/useTimeout/useTimeout.js +2 -2
  193. package/dist/cjs/hooks/useTimeout/useTimeout.js.map +1 -1
  194. package/dist/cjs/hooks/useTimer/useTimer.js +2 -2
  195. package/dist/cjs/hooks/useTimer/useTimer.js.map +1 -1
  196. package/dist/cjs/hooks/useToggle/useToggle.js +2 -2
  197. package/dist/cjs/hooks/useToggle/useToggle.js.map +1 -1
  198. package/dist/cjs/hooks/useUnmount/useUnmount.js +1 -1
  199. package/dist/cjs/hooks/useUnmount/useUnmount.js.map +1 -1
  200. package/dist/cjs/hooks/useWebSocket/useWebSocket.js +2 -2
  201. package/dist/cjs/hooks/useWebSocket/useWebSocket.js.map +1 -1
  202. package/dist/cjs/hooks/useWindowEvent/useWindowEvent.js +2 -2
  203. package/dist/cjs/hooks/useWindowEvent/useWindowEvent.js.map +1 -1
  204. package/dist/cjs/hooks/useWindowFocus/useWindowFocus.js +3 -0
  205. package/dist/cjs/hooks/useWindowFocus/useWindowFocus.js.map +1 -0
  206. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.js +2 -2
  207. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.js.map +1 -1
  208. package/dist/cjs/hooks/useWindowSize/useWindowSize.js +2 -2
  209. package/dist/cjs/hooks/useWindowSize/useWindowSize.js.map +1 -1
  210. package/dist/cjs/hooks/useWizard/useWizard.js +2 -2
  211. package/dist/cjs/hooks/useWizard/useWizard.js.map +1 -1
  212. package/dist/cjs/{index-Bi1s-nNB.js → index-CcADclzU.js} +2 -2
  213. package/dist/cjs/{index-Bi1s-nNB.js.map → index-CcADclzU.js.map} +1 -1
  214. package/dist/cjs/index.js +2 -2
  215. package/dist/cjs/utils/helpers/debounce.js +1 -1
  216. package/dist/cjs/utils/helpers/debounce.js.map +1 -1
  217. package/dist/cjs/utils/helpers/getElement.js +1 -1
  218. package/dist/cjs/utils/helpers/getElement.js.map +1 -1
  219. package/dist/cjs/utils/helpers/getRetry.js +1 -1
  220. package/dist/cjs/utils/helpers/getRetry.js.map +1 -1
  221. package/dist/cjs/utils/helpers/index.js +1 -1
  222. package/dist/cjs/utils/helpers/isClient.js +1 -1
  223. package/dist/cjs/utils/helpers/throttle.js +1 -1
  224. package/dist/cjs/utils/helpers/throttle.js.map +1 -1
  225. package/dist/cjs/utils/helpers/time/getDate.js +1 -1
  226. package/dist/esm/_rollupPluginBabelHelpers-DTOtzY47.js +3 -0
  227. package/dist/esm/_rollupPluginBabelHelpers-DTOtzY47.js.map +1 -0
  228. package/dist/esm/hooks/index.js +2 -2
  229. package/dist/esm/hooks/useActiveElement/useActiveElement.js +3 -0
  230. package/dist/esm/hooks/useActiveElement/useActiveElement.js.map +1 -0
  231. package/dist/esm/hooks/useAsync/useAsync.js +2 -2
  232. package/dist/esm/hooks/useAsync/useAsync.js.map +1 -1
  233. package/dist/esm/hooks/useBattery/useBattery.js +2 -2
  234. package/dist/esm/hooks/useBattery/useBattery.js.map +1 -1
  235. package/dist/esm/hooks/useBoolean/useBoolean.js +2 -2
  236. package/dist/esm/hooks/useBoolean/useBoolean.js.map +1 -1
  237. package/dist/esm/hooks/useBreakpoints/constants/breakpoints.js +1 -1
  238. package/dist/esm/hooks/useBreakpoints/useBreakpoints.js +2 -2
  239. package/dist/esm/hooks/useBreakpoints/useBreakpoints.js.map +1 -1
  240. package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  241. package/dist/esm/hooks/useClickOutside/useClickOutside.js +2 -2
  242. package/dist/esm/hooks/useClickOutside/useClickOutside.js.map +1 -1
  243. package/dist/esm/hooks/useClipboard/useClipboard.js +2 -2
  244. package/dist/esm/hooks/useClipboard/useClipboard.js.map +1 -1
  245. package/dist/esm/hooks/useCounter/useCounter.js +2 -2
  246. package/dist/esm/hooks/useCounter/useCounter.js.map +1 -1
  247. package/dist/esm/hooks/useCssVar/useCssVar.js +2 -2
  248. package/dist/esm/hooks/useCssVar/useCssVar.js.map +1 -1
  249. package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  250. package/dist/esm/hooks/useDebounceValue/useDebounceValue.js +2 -2
  251. package/dist/esm/hooks/useDefault/useDefault.js +2 -2
  252. package/dist/esm/hooks/useDefault/useDefault.js.map +1 -1
  253. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js +2 -2
  254. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -1
  255. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js +2 -2
  256. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -1
  257. package/dist/esm/hooks/useDidUpdate/useDidUpdate.js +1 -1
  258. package/dist/esm/hooks/useDidUpdate/useDidUpdate.js.map +1 -1
  259. package/dist/esm/hooks/useDisclosure/useDisclosure.js +2 -2
  260. package/dist/esm/hooks/useDisclosure/useDisclosure.js.map +1 -1
  261. package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  262. package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.js.map +1 -1
  263. package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  264. package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.js.map +1 -1
  265. package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  266. package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.js.map +1 -1
  267. package/dist/esm/hooks/useEvent/useEvent.js +1 -1
  268. package/dist/esm/hooks/useEventListener/useEventListener.js +2 -2
  269. package/dist/esm/hooks/useEventListener/useEventListener.js.map +1 -1
  270. package/dist/esm/hooks/useEyeDropper/useEyeDropper.js +2 -2
  271. package/dist/esm/hooks/useEyeDropper/useEyeDropper.js.map +1 -1
  272. package/dist/esm/hooks/useFavicon/useFavicon.js +2 -2
  273. package/dist/esm/hooks/useFavicon/useFavicon.js.map +1 -1
  274. package/dist/esm/hooks/useField/useField.js +2 -2
  275. package/dist/esm/hooks/useField/useField.js.map +1 -1
  276. package/dist/esm/hooks/useFileDialog/useFileDialog.js +2 -2
  277. package/dist/esm/hooks/useFileDialog/useFileDialog.js.map +1 -1
  278. package/dist/esm/hooks/useFocus/useFocus.js +2 -2
  279. package/dist/esm/hooks/useFocus/useFocus.js.map +1 -1
  280. package/dist/esm/hooks/useFps/useFps.js +2 -2
  281. package/dist/esm/hooks/useFps/useFps.js.map +1 -1
  282. package/dist/esm/hooks/useFullscreen/useFullscreen.js +2 -2
  283. package/dist/esm/hooks/useFullscreen/useFullscreen.js.map +1 -1
  284. package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +1 -1
  285. package/dist/esm/hooks/useGamepad/useGamepad.js +2 -2
  286. package/dist/esm/hooks/useGamepad/useGamepad.js.map +1 -1
  287. package/dist/esm/hooks/useGeolocation/useGeolocation.js +2 -2
  288. package/dist/esm/hooks/useGeolocation/useGeolocation.js.map +1 -1
  289. package/dist/esm/hooks/useHash/useHash.js +2 -2
  290. package/dist/esm/hooks/useHash/useHash.js.map +1 -1
  291. package/dist/esm/hooks/useHotkeys/useHotkeys.js +2 -2
  292. package/dist/esm/hooks/useHotkeys/useHotkeys.js.map +1 -1
  293. package/dist/esm/hooks/useHover/useHover.js +2 -2
  294. package/dist/esm/hooks/useHover/useHover.js.map +1 -1
  295. package/dist/esm/hooks/useIdle/useIdle.js +2 -2
  296. package/dist/esm/hooks/useIdle/useIdle.js.map +1 -1
  297. package/dist/esm/hooks/useImage/useImage.js +2 -2
  298. package/dist/esm/hooks/useImage/useImage.js.map +1 -1
  299. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  300. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.js.map +1 -1
  301. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  302. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.js.map +1 -1
  303. package/dist/esm/hooks/useInterval/useInterval.js +2 -2
  304. package/dist/esm/hooks/useInterval/useInterval.js.map +1 -1
  305. package/dist/esm/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  306. package/dist/esm/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  307. package/dist/esm/hooks/useKeyPress/useKeyPress.js +2 -2
  308. package/dist/esm/hooks/useKeyPress/useKeyPress.js.map +1 -1
  309. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  310. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.js.map +1 -1
  311. package/dist/esm/hooks/useKeyboard/useKeyboard.js +2 -2
  312. package/dist/esm/hooks/useKeyboard/useKeyboard.js.map +1 -1
  313. package/dist/esm/hooks/useKeysPressed/useKeysPressed.js +2 -2
  314. package/dist/esm/hooks/useKeysPressed/useKeysPressed.js.map +1 -1
  315. package/dist/esm/hooks/useLastChanged/useLastChanged.js +2 -2
  316. package/dist/esm/hooks/useLastChanged/useLastChanged.js.map +1 -1
  317. package/dist/esm/hooks/useList/useList.js +2 -2
  318. package/dist/esm/hooks/useList/useList.js.map +1 -1
  319. package/dist/esm/hooks/useLocalStorage/useLocalStorage.js +2 -2
  320. package/dist/esm/hooks/useLocalStorage/useLocalStorage.js.map +1 -1
  321. package/dist/esm/hooks/useLogger/useLogger.js +2 -2
  322. package/dist/esm/hooks/useLongPress/useLongPress.js +2 -2
  323. package/dist/esm/hooks/useLongPress/useLongPress.js.map +1 -1
  324. package/dist/esm/hooks/useMap/useMap.js +2 -2
  325. package/dist/esm/hooks/useMap/useMap.js.map +1 -1
  326. package/dist/esm/hooks/useMeasure/useMeasure.js +2 -2
  327. package/dist/esm/hooks/useMeasure/useMeasure.js.map +1 -1
  328. package/dist/esm/hooks/useMediaQuery/useMediaQuery.js +1 -1
  329. package/dist/esm/hooks/useMediaQuery/useMediaQuery.js.map +1 -1
  330. package/dist/esm/hooks/useMemory/useMemory.js +2 -2
  331. package/dist/esm/hooks/useMount/useMount.js +1 -1
  332. package/dist/esm/hooks/useMount/useMount.js.map +1 -1
  333. package/dist/esm/hooks/useMouse/useMouse.js +2 -2
  334. package/dist/esm/hooks/useMouse/useMouse.js.map +1 -1
  335. package/dist/esm/hooks/useMutation/useMutation.js +2 -2
  336. package/dist/esm/hooks/useMutation/useMutation.js.map +1 -1
  337. package/dist/esm/hooks/useMutationObserver/useMutationObserver.js +2 -2
  338. package/dist/esm/hooks/useMutationObserver/useMutationObserver.js.map +1 -1
  339. package/dist/esm/hooks/useNetwork/useNetwork.js +2 -2
  340. package/dist/esm/hooks/useNetwork/useNetwork.js.map +1 -1
  341. package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  342. package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.js.map +1 -1
  343. package/dist/esm/hooks/useOnline/useOnline.js +1 -1
  344. package/dist/esm/hooks/useOnline/useOnline.js.map +1 -1
  345. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.js +1 -1
  346. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.js.map +1 -1
  347. package/dist/esm/hooks/useOptimistic/useOptimistic.js +2 -2
  348. package/dist/esm/hooks/useOptimistic/useOptimistic.js.map +1 -1
  349. package/dist/esm/hooks/useOrientation/useOrientation.js +2 -2
  350. package/dist/esm/hooks/useOrientation/useOrientation.js.map +1 -1
  351. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js +2 -2
  352. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  353. package/dist/esm/hooks/usePageLeave/usePageLeave.js +2 -2
  354. package/dist/esm/hooks/usePageLeave/usePageLeave.js.map +1 -1
  355. package/dist/esm/hooks/usePaint/helpers/Paint.js +2 -2
  356. package/dist/esm/hooks/usePaint/helpers/Paint.js.map +1 -1
  357. package/dist/esm/hooks/usePaint/helpers/Pointer.js +2 -2
  358. package/dist/esm/hooks/usePaint/usePaint.js +2 -2
  359. package/dist/esm/hooks/usePaint/usePaint.js.map +1 -1
  360. package/dist/esm/hooks/useParallax/useParallax.js +2 -2
  361. package/dist/esm/hooks/useParallax/useParallax.js.map +1 -1
  362. package/dist/esm/hooks/usePermission/usePermission.js +2 -2
  363. package/dist/esm/hooks/usePermission/usePermission.js.map +1 -1
  364. package/dist/esm/hooks/usePointerLock/usePointerLock.js +3 -0
  365. package/dist/esm/hooks/usePointerLock/usePointerLock.js.map +1 -0
  366. package/dist/esm/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  367. package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  368. package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.js.map +1 -1
  369. package/dist/esm/hooks/usePreferredDark/usePreferredDark.js +1 -1
  370. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  371. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.js.map +1 -1
  372. package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  373. package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js.map +1 -1
  374. package/dist/esm/hooks/usePrevious/usePrevious.js +1 -1
  375. package/dist/esm/hooks/useQuery/useQuery.js +2 -2
  376. package/dist/esm/hooks/useQuery/useQuery.js.map +1 -1
  377. package/dist/esm/hooks/useQueue/useQueue.js +2 -2
  378. package/dist/esm/hooks/useQueue/useQueue.js.map +1 -1
  379. package/dist/esm/hooks/useRaf/useRaf.js +2 -2
  380. package/dist/esm/hooks/useRaf/useRaf.js.map +1 -1
  381. package/dist/esm/hooks/useRafValue/useRafValue.js +2 -2
  382. package/dist/esm/hooks/useRafValue/useRafValue.js.map +1 -1
  383. package/dist/esm/hooks/useRenderCount/useRenderCount.js +1 -1
  384. package/dist/esm/hooks/useRenderInfo/useRenderInfo.js +1 -1
  385. package/dist/esm/hooks/useRenderInfo/useRenderInfo.js.map +1 -1
  386. package/dist/esm/hooks/useRerender/useRerender.js +2 -2
  387. package/dist/esm/hooks/useRerender/useRerender.js.map +1 -1
  388. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js +2 -2
  389. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  390. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js +2 -2
  391. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -1
  392. package/dist/esm/hooks/useScript/useScript.js +2 -2
  393. package/dist/esm/hooks/useScript/useScript.js.map +1 -1
  394. package/dist/esm/hooks/useSessionStorage/useSessionStorage.js +2 -2
  395. package/dist/esm/hooks/useSessionStorage/useSessionStorage.js.map +1 -1
  396. package/dist/esm/hooks/useSet/useSet.js +2 -2
  397. package/dist/esm/hooks/useSet/useSet.js.map +1 -1
  398. package/dist/esm/hooks/useShare/useShare.js +2 -2
  399. package/dist/esm/hooks/useShare/useShare.js.map +1 -1
  400. package/dist/esm/hooks/useStep/useStep.js +2 -2
  401. package/dist/esm/hooks/useStep/useStep.js.map +1 -1
  402. package/dist/esm/hooks/useStopwatch/useStopwatch.js +2 -2
  403. package/dist/esm/hooks/useStopwatch/useStopwatch.js.map +1 -1
  404. package/dist/esm/hooks/useStorage/useStorage.js +2 -2
  405. package/dist/esm/hooks/useStorage/useStorage.js.map +1 -1
  406. package/dist/esm/hooks/useTextSelection/useTextSelection.js +2 -2
  407. package/dist/esm/hooks/useTextSelection/useTextSelection.js.map +1 -1
  408. package/dist/esm/hooks/useTime/useTime.js +2 -2
  409. package/dist/esm/hooks/useTime/useTime.js.map +1 -1
  410. package/dist/esm/hooks/useTimeout/useTimeout.js +2 -2
  411. package/dist/esm/hooks/useTimeout/useTimeout.js.map +1 -1
  412. package/dist/esm/hooks/useTimer/useTimer.js +2 -2
  413. package/dist/esm/hooks/useTimer/useTimer.js.map +1 -1
  414. package/dist/esm/hooks/useToggle/useToggle.js +2 -2
  415. package/dist/esm/hooks/useToggle/useToggle.js.map +1 -1
  416. package/dist/esm/hooks/useUnmount/useUnmount.js +1 -1
  417. package/dist/esm/hooks/useUnmount/useUnmount.js.map +1 -1
  418. package/dist/esm/hooks/useWebSocket/useWebSocket.js +2 -2
  419. package/dist/esm/hooks/useWebSocket/useWebSocket.js.map +1 -1
  420. package/dist/esm/hooks/useWindowEvent/useWindowEvent.js +2 -2
  421. package/dist/esm/hooks/useWindowEvent/useWindowEvent.js.map +1 -1
  422. package/dist/esm/hooks/useWindowFocus/useWindowFocus.js +3 -0
  423. package/dist/esm/hooks/useWindowFocus/useWindowFocus.js.map +1 -0
  424. package/dist/esm/hooks/useWindowScroll/useWindowScroll.js +2 -2
  425. package/dist/esm/hooks/useWindowScroll/useWindowScroll.js.map +1 -1
  426. package/dist/esm/hooks/useWindowSize/useWindowSize.js +2 -2
  427. package/dist/esm/hooks/useWindowSize/useWindowSize.js.map +1 -1
  428. package/dist/esm/hooks/useWizard/useWizard.js +2 -2
  429. package/dist/esm/hooks/useWizard/useWizard.js.map +1 -1
  430. package/dist/esm/{index-DaDsOQsh.js → index-CwmydaHB.js} +2 -2
  431. package/dist/esm/{index-DaDsOQsh.js.map → index-CwmydaHB.js.map} +1 -1
  432. package/dist/esm/index.js +2 -2
  433. package/dist/esm/utils/helpers/debounce.js +1 -1
  434. package/dist/esm/utils/helpers/debounce.js.map +1 -1
  435. package/dist/esm/utils/helpers/getElement.js +1 -1
  436. package/dist/esm/utils/helpers/getElement.js.map +1 -1
  437. package/dist/esm/utils/helpers/getRetry.js +1 -1
  438. package/dist/esm/utils/helpers/getRetry.js.map +1 -1
  439. package/dist/esm/utils/helpers/index.js +1 -1
  440. package/dist/esm/utils/helpers/isClient.js +1 -1
  441. package/dist/esm/utils/helpers/throttle.js +1 -1
  442. package/dist/esm/utils/helpers/throttle.js.map +1 -1
  443. package/dist/esm/utils/helpers/time/getDate.js +1 -1
  444. package/dist/index.d.ts +311 -260
  445. package/package.json +15 -14
  446. package/dist/cjs/_rollupPluginBabelHelpers-mppFXOYB.js +0 -3
  447. package/dist/cjs/_rollupPluginBabelHelpers-mppFXOYB.js.map +0 -1
  448. package/dist/esm/_rollupPluginBabelHelpers-DnmVbpNy.js +0 -3
  449. package/dist/esm/_rollupPluginBabelHelpers-DnmVbpNy.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -1,11 +1,23 @@
1
1
  import * as react from 'react';
2
- import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect, MouseEventHandler, TouchEventHandler } from 'react';
2
+ import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect, MouseEventHandler, TouchEventHandler, MouseEvent as MouseEvent$1 } from 'react';
3
+
4
+ /**
5
+ * @name useActiveElement
6
+ * @description - Hook that returns the active element
7
+ * @category Elements
8
+ *
9
+ * @returns {ActiveElement | null} The active element
10
+ *
11
+ * @example
12
+ * const activeElement = useActiveElement();
13
+ */
14
+ declare const useActiveElement: <ActiveElement extends HTMLElement>() => ActiveElement | null;
3
15
 
4
16
  interface UseAsyncReturn<Data> {
5
17
  data?: Data;
6
- isLoading: boolean;
7
- isError: boolean;
8
18
  error?: Error;
19
+ isError: boolean;
20
+ isLoading: boolean;
9
21
  }
10
22
  /**
11
23
  * @name useAsync
@@ -32,12 +44,8 @@ declare global {
32
44
  readonly getBattery: () => Promise<BatteryManager>;
33
45
  }
34
46
  }
35
- /** State for hook use battery */
36
- interface UseBatteryStateReturn {
37
- /** Is battery API supported? */
38
- supported: boolean;
39
- /** Is battery information loading? */
40
- loading: boolean;
47
+ /** The use battery value type */
48
+ interface UseBatteryValue {
41
49
  /** Is charging battery? */
42
50
  charging: boolean;
43
51
  /** Time until the battery is fully charged */
@@ -46,6 +54,15 @@ interface UseBatteryStateReturn {
46
54
  dischargingTime: number;
47
55
  /** Battery charge level from 0 to 1 */
48
56
  level: number;
57
+ /** Is battery information loading? */
58
+ loading: boolean;
59
+ }
60
+ /** The use battery return type */
61
+ interface UseBatteryStateReturn {
62
+ /** Battery API support */
63
+ supported: boolean;
64
+ /** The use battery value type */
65
+ value: UseBatteryValue;
49
66
  }
50
67
  /**
51
68
  * @name useBattery
@@ -163,7 +180,7 @@ declare const BREAKPOINTS_PRIME_FLEX: {
163
180
  /** The breakpoints type */
164
181
  type Breakpoints<Breakpoint extends string = string> = Record<Breakpoint, number>;
165
182
  /** The use breakpoints strategy */
166
- type UseBreakpointsStrategy = 'mobile-first' | 'desktop-first';
183
+ type UseBreakpointsStrategy = 'desktop-first' | 'mobile-first';
167
184
  /** The use breakpoints return type */
168
185
  type UseBreakpointsReturn<Breakpoint extends string = string> = {
169
186
  /** The function that checks if the current breakpoint is greater than to the given breakpoint */
@@ -219,7 +236,7 @@ declare const useBreakpoints: <Breakpoint extends string>(breakpoints: Breakpoin
219
236
  declare const useBrowserLanguage: () => string;
220
237
 
221
238
  /** The use click outside target element type */
222
- type UseClickOutsideTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
239
+ type UseClickOutsideTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
223
240
  interface UseClickOutside {
224
241
  <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(target: Target, callback: (event: Event) => void): void;
225
242
  <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): (node: Target) => void;
@@ -252,12 +269,12 @@ declare const isPermissionAllowed: (status: PermissionState) => status is "promp
252
269
  declare const legacyCopyToClipboard: (value: string) => void;
253
270
  /** The use copy to clipboard return type */
254
271
  interface UseCopyToClipboardReturn {
272
+ /** Whether the copy to clipboard is supported */
273
+ supported: boolean;
255
274
  /** The copied value */
256
275
  value: string | null;
257
276
  /** Function to copy to clipboard */
258
277
  copy: (value: string) => Promise<void>;
259
- /** Whether the copy to clipboard is supported */
260
- supported: boolean;
261
278
  }
262
279
  /** The use copy to clipboard params type */
263
280
  interface UseCopyToClipboardParams {
@@ -279,23 +296,23 @@ declare const useClipboard: (params?: UseCopyToClipboardParams) => UseCopyToClip
279
296
 
280
297
  /** The use counter options */
281
298
  interface UseCounterOptions {
282
- /** The min of count value */
283
- min?: number;
284
299
  /** The max of count value */
285
300
  max?: number;
301
+ /** The min of count value */
302
+ min?: number;
286
303
  }
287
304
  /** The use counter return type */
288
305
  interface UseCounterReturn {
289
- /** The current count value */
290
- value: number;
291
306
  /** Function to set a specific value to the counter */
292
307
  set: Dispatch<SetStateAction<number>>;
293
- /** Function to reset the counter to its initial value. */
294
- reset: () => void;
295
- /** Function to increment the counter */
296
- inc: (value?: number) => void;
308
+ /** The current count value */
309
+ value: number;
297
310
  /** Function to decrement the counter */
298
311
  dec: (value?: number) => void;
312
+ /** Function to increment the counter */
313
+ inc: (value?: number) => void;
314
+ /** Function to reset the counter to its initial value. */
315
+ reset: () => void;
299
316
  }
300
317
  interface UseCounter {
301
318
  (initialValue?: number, options?: UseCounterOptions): UseCounterReturn;
@@ -329,7 +346,7 @@ interface UseCounter {
329
346
  declare const useCounter: UseCounter;
330
347
 
331
348
  /** The css variable target element type */
332
- type UseCssVarTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
349
+ type UseCssVarTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
333
350
  /** The css variable return type */
334
351
  interface UseCssVarReturn {
335
352
  /** The value of the CSS variable */
@@ -410,21 +427,21 @@ declare const useDebounceValue: <Value>(value: Value, delay: number) => Value;
410
427
  * @example
411
428
  * const [value, setValue] = useDefault(initialValue, defaultValue);
412
429
  */
413
- declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultValue: Value) => readonly [Value, react.Dispatch<react.SetStateAction<Value | null | undefined>>];
430
+ declare const useDefault: <Value>(initialValue: (() => Value) | Value, defaultValue: Value) => readonly [Value, react.Dispatch<react.SetStateAction<Value | null | undefined>>];
414
431
 
415
432
  interface UseDeviceMotionReturn {
416
- interval: DeviceMotionEvent['interval'];
417
433
  acceleration: DeviceMotionEventAcceleration;
418
434
  accelerationIncludingGravity: DeviceMotionEventAcceleration;
435
+ interval: DeviceMotionEvent['interval'];
419
436
  rotationRate: DeviceMotionEventRotationRate;
420
437
  }
421
438
  interface UseDeviceMotionParams {
422
439
  /** The delay in milliseconds */
423
440
  delay?: number;
424
- /** The callback function to be invoked */
425
- callback?: (event: DeviceMotionEvent) => void;
426
441
  /** Whether to enable the hook */
427
442
  enabled?: boolean;
443
+ /** The callback function to be invoked */
444
+ callback?: (event: DeviceMotionEvent) => void;
428
445
  }
429
446
  /**
430
447
  * @name useDeviceMotion
@@ -442,14 +459,14 @@ interface UseDeviceMotionParams {
442
459
  declare const useDeviceMotion: (params?: UseDeviceMotionParams) => UseDeviceMotionReturn;
443
460
 
444
461
  interface UseDeviceOrientationValue {
462
+ /** The current absolute value */
463
+ absolute: boolean;
445
464
  /** A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 to 360 */
446
465
  alpha: number | null;
447
466
  /** A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 to 180 */
448
467
  beta: number | null;
449
468
  /** A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 to 90 */
450
469
  gamma: number | null;
451
- /** The current absolute value */
452
- absolute: boolean;
453
470
  }
454
471
  interface UseDeviceOrientationReturn {
455
472
  /** Whether the device orientation is supported */
@@ -484,19 +501,19 @@ declare const useDidUpdate: (effect: EffectCallback, deps?: DependencyList) => v
484
501
 
485
502
  /** The use disclosure options type */
486
503
  interface UseDisclosureOptions {
487
- /** The callback function to be invoked on open */
488
- onOpen?: () => void;
489
504
  /** The callback function to be invoked on close */
490
505
  onClose?: () => void;
506
+ /** The callback function to be invoked on open */
507
+ onOpen?: () => void;
491
508
  }
492
509
  /** The use disclosure return type */
493
510
  interface UseDisclosureReturn {
494
511
  /** The opened value */
495
512
  opened: boolean;
496
- /** Function to open the modal */
497
- open: () => void;
498
513
  /** Function to close the modal */
499
514
  close: () => void;
515
+ /** Function to open the modal */
516
+ open: () => void;
500
517
  /** Function to toggle the modal */
501
518
  toggle: () => void;
502
519
  }
@@ -515,7 +532,7 @@ interface UseDisclosureReturn {
515
532
  */
516
533
  declare const useDisclosure: (initialValue?: boolean, options?: UseDisclosureOptions) => UseDisclosureReturn;
517
534
 
518
- type UseEventListenerTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
535
+ type UseEventListenerTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
519
536
  type UseEventListenerOptions = boolean | AddEventListenerOptions;
520
537
  type UseEventListenerReturn<Target extends UseEventListenerTarget> = RefObject<Target>;
521
538
  interface UseEventListener {
@@ -655,35 +672,37 @@ declare const useFavicon: (initialHref?: string) => {
655
672
 
656
673
  /** The use field params type */
657
674
  interface UseFieldParams<Value> {
658
- /** The initial value */
659
- initialValue?: Value;
660
- /** The initial touched */
661
- initialTouched?: boolean;
662
675
  /** The auto focus */
663
676
  autoFocus?: boolean;
664
- /** The validate on mount */
665
- validateOnChange?: boolean;
677
+ /** The initial touched */
678
+ initialTouched?: boolean;
679
+ /** The initial value */
680
+ initialValue?: Value;
666
681
  /** The validate on blur */
667
682
  validateOnBlur?: boolean;
668
683
  /** The validate on mount */
684
+ validateOnChange?: boolean;
685
+ /** The validate on mount */
669
686
  validateOnMount?: boolean;
670
687
  }
671
688
  /** The use field register params type */
672
689
  interface UseFieldRegisterParams {
673
690
  /** The required validation */
674
691
  required?: string;
692
+ /** The custom validation */
693
+ validate?: (value: string) => Promise<string | true>;
675
694
  /** The min value validation */
676
695
  max?: {
677
696
  value: number;
678
697
  message: string;
679
698
  };
680
- /** The max value validation */
681
- min?: {
699
+ /** The max length validation */
700
+ maxLength?: {
682
701
  value: number;
683
702
  message: string;
684
703
  };
685
- /** The max length validation */
686
- maxLength?: {
704
+ /** The max value validation */
705
+ min?: {
687
706
  value: number;
688
707
  message: string;
689
708
  };
@@ -697,37 +716,35 @@ interface UseFieldRegisterParams {
697
716
  value: RegExp;
698
717
  message: string;
699
718
  };
700
- /** The custom validation */
701
- validate?: (value: string) => Promise<string | true>;
702
719
  }
703
720
  /** The use field return type */
704
721
  interface UseFieldReturn<Value> {
705
- /** The register function */
706
- register: (params?: UseFieldRegisterParams) => {
707
- onBlur: () => void;
708
- onChange: () => void;
709
- ref: (node: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | null | undefined) => void;
710
- };
711
- /** The get value function */
712
- getValue: () => Value;
713
- /** The set value function */
714
- setValue: (value: Value) => void;
715
722
  /** The dirty state */
716
723
  dirty: boolean;
717
724
  /** The error state */
718
725
  error?: string;
719
726
  /** The set error function */
720
727
  touched: boolean;
728
+ /** The set error function */
729
+ clearError: () => void;
721
730
  /** The focus function */
722
731
  focus: () => void;
723
- /** The watch function */
724
- watch: () => Value;
732
+ /** The get value function */
733
+ getValue: () => Value;
734
+ /** The register function */
735
+ register: (params?: UseFieldRegisterParams) => {
736
+ onBlur: () => void;
737
+ onChange: () => void;
738
+ ref: (node: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | null | undefined) => void;
739
+ };
725
740
  /** The reset function */
726
741
  reset: () => void;
727
742
  /** The set error function */
728
743
  setError: (error: string) => void;
729
- /** The set error function */
730
- clearError: () => void;
744
+ /** The set value function */
745
+ setValue: (value: Value) => void;
746
+ /** The watch function */
747
+ watch: () => Value;
731
748
  }
732
749
  /**
733
750
  * @name useField
@@ -747,9 +764,9 @@ interface UseFieldReturn<Value> {
747
764
  * @example
748
765
  * const { register, getValue, setValue, reset, dirty, error, setError, clearError, touched, focus, watch } = useField();
749
766
  */
750
- declare const useField: <Value extends string | boolean = string, Type = Value extends string ? string : boolean>(params?: UseFieldParams<Value>) => UseFieldReturn<Type>;
767
+ declare const useField: <Value extends boolean | string = string, Type = Value extends string ? string : boolean>(params?: UseFieldParams<Value>) => UseFieldReturn<Type>;
751
768
 
752
- interface UseFileDialogOptions extends Pick<ComponentProps<'input'>, 'multiple' | 'accept'> {
769
+ interface UseFileDialogOptions extends Pick<ComponentProps<'input'>, 'accept' | 'multiple'> {
753
770
  /** The capture value */
754
771
  capture?: string;
755
772
  /** The reset value */
@@ -795,7 +812,7 @@ interface UseFileDialog {
795
812
  */
796
813
  declare const useFileDialog: UseFileDialog;
797
814
 
798
- type UseFocusTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
815
+ type UseFocusTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
799
816
  /** The use focus options type */
800
817
  interface UseFocusOptions {
801
818
  /** The initial focus state of the target */
@@ -803,12 +820,12 @@ interface UseFocusOptions {
803
820
  }
804
821
  /** The use focus return type */
805
822
  interface UseFocusReturn {
806
- /** Is the target focused */
807
- focus: () => void;
808
- /** Is the target focused */
809
- blur: () => void;
810
823
  /** The boolean state value of the target */
811
824
  focused: boolean;
825
+ /** Is the target focused */
826
+ blur: () => void;
827
+ /** Is the target focused */
828
+ focus: () => void;
812
829
  }
813
830
  interface UseFocus {
814
831
  <Target extends UseFocusTarget>(target: Target, options?: UseFocusOptions): UseFocusReturn;
@@ -852,7 +869,7 @@ declare const useFocus: UseFocus;
852
869
  declare const useFps: () => number;
853
870
 
854
871
  /** The use fullscreen target element type */
855
- type UseFullScreenTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
872
+ type UseFullScreenTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
856
873
  /** The use fullscreen options type */
857
874
  interface UseFullScreenOptions {
858
875
  /** initial value */
@@ -864,10 +881,10 @@ interface UseFullScreenOptions {
864
881
  }
865
882
  /** The use click outside return type */
866
883
  interface UseFullScreenReturn {
884
+ value: boolean;
867
885
  enter: () => void;
868
886
  exit: () => void;
869
887
  toggle: () => void;
870
- value: boolean;
871
888
  }
872
889
  interface UseFullScreen {
873
890
  <Target extends UseFullScreenTarget>(target: Target, options?: UseFullScreenOptions): UseFullScreenReturn;
@@ -947,12 +964,12 @@ declare global {
947
964
  }
948
965
  /** The use gamepad return type */
949
966
  interface UseGamepadStateReturn {
950
- /** The gamepad supported status */
951
- supported: boolean;
952
- /** The gamepad state */
953
- gamepads: Gamepad[];
954
967
  /** The gamepad active status */
955
968
  active: boolean;
969
+ /** The gamepad state */
970
+ gamepads: Gamepad[];
971
+ /** The gamepad supported status */
972
+ supported: boolean;
956
973
  }
957
974
  /**
958
975
  * @name useGamepad
@@ -972,26 +989,26 @@ declare const useGamepad: () => {
972
989
 
973
990
  /** The use geolocation return type */
974
991
  interface UseGeolocationReturn {
975
- /** The loading state */
976
- loading: boolean;
977
- /** The error of the last position update */
978
- error: GeolocationPositionError | null;
979
- /** The timestamp of the last position update */
980
- timestamp: number | null;
981
992
  /** The accuracy of the last position update */
982
993
  accuracy: number | null;
983
- /** The latitude of the last position update */
984
- latitude: number | null;
985
- /** The longitude of the last position update */
986
- longitude: number | null;
987
994
  /** The altitude of the last position update */
988
995
  altitude: number | null;
989
996
  /** The altitude accuracy of the last position update */
990
997
  altitudeAccuracy: number | null;
998
+ /** The error of the last position update */
999
+ error: GeolocationPositionError | null;
991
1000
  /** The heading of the last position update */
992
1001
  heading: number | null;
1002
+ /** The latitude of the last position update */
1003
+ latitude: number | null;
1004
+ /** The loading state */
1005
+ loading: boolean;
1006
+ /** The longitude of the last position update */
1007
+ longitude: number | null;
993
1008
  /** The speed of the last position update */
994
1009
  speed: number | null;
1010
+ /** The timestamp of the last position update */
1011
+ timestamp: number | null;
995
1012
  }
996
1013
  /** The use geolocation params type */
997
1014
  type UseGeolocationParams = PositionOptions;
@@ -1026,21 +1043,21 @@ declare const useHash: () => UseHashReturn;
1026
1043
 
1027
1044
  /** The use hotkeys params type */
1028
1045
  interface UseHotkeysOptions {
1029
- /** The target to attach the event listeners to */
1030
- target?: UseEventListenerTarget;
1046
+ /** Alias map for hotkeys */
1047
+ aliasMap?: Record<string, string>;
1031
1048
  /** Enable or disable the event listeners */
1032
1049
  enabled?: boolean;
1033
1050
  /** Whether to prevent the default behavior of the event */
1034
1051
  preventDefault?: boolean;
1035
- /** Alias map for hotkeys */
1036
- aliasMap?: Record<string, string>;
1052
+ /** The target to attach the event listeners to */
1053
+ target?: UseEventListenerTarget;
1037
1054
  }
1038
1055
  declare const isHotkeyMatch: (hotkey: string, keys: UseHotkeysKey[]) => boolean;
1039
- type UseHotkeysHotkeys = string[] | string;
1056
+ type UseHotkeysHotkeys = string | string[];
1040
1057
  interface UseHotkeysKey {
1041
- key: string;
1042
- code: string;
1043
1058
  alias: string;
1059
+ code: string;
1060
+ key: string;
1044
1061
  }
1045
1062
  /**
1046
1063
  * @name useHotkeys
@@ -1067,7 +1084,7 @@ interface UseHoverOptions {
1067
1084
  onEntry?: () => void;
1068
1085
  onLeave?: () => void;
1069
1086
  }
1070
- type UseHoverTarget = RefObject<Element | null | undefined> | Element;
1087
+ type UseHoverTarget = Element | RefObject<Element | null | undefined>;
1071
1088
  interface UseHover {
1072
1089
  <Target extends UseHoverTarget>(target: Target, callback?: () => void): boolean;
1073
1090
  <Target extends UseHoverTarget>(target: Target, options?: UseHoverOptions): boolean;
@@ -1124,8 +1141,8 @@ interface UseHover {
1124
1141
  declare const useHover: UseHover;
1125
1142
 
1126
1143
  interface UseIdleOptions {
1127
- initialValue?: boolean;
1128
1144
  events?: Array<keyof DocumentEventMap>;
1145
+ initialValue?: boolean;
1129
1146
  }
1130
1147
  interface UseIdleReturn {
1131
1148
  idle: boolean;
@@ -1147,30 +1164,30 @@ interface UseIdleReturn {
1147
1164
  declare const useIdle: (milliseconds?: number, { initialValue, events }?: UseIdleOptions) => UseIdleReturn;
1148
1165
 
1149
1166
  interface UseQueryOptions<QueryData, Data> {
1167
+ enabled?: boolean;
1168
+ initialData?: (() => Data) | Data;
1150
1169
  keys?: DependencyList;
1151
- onSuccess?: (data: Data) => void;
1170
+ placeholderData?: (() => Data) | Data;
1171
+ refetchInterval?: number;
1172
+ retry?: boolean | number;
1152
1173
  onError?: (error: Error) => void;
1174
+ onSuccess?: (data: Data) => void;
1153
1175
  select?: (data: QueryData) => Data;
1154
- initialData?: Data | (() => Data);
1155
- placeholderData?: Data | (() => Data);
1156
- retry?: boolean | number;
1157
- refetchInterval?: number;
1158
- enabled?: boolean;
1159
1176
  }
1160
1177
  interface UseQueryCallbackParams {
1161
- signal: AbortSignal;
1162
1178
  keys: DependencyList;
1179
+ signal: AbortSignal;
1163
1180
  }
1164
1181
  interface UseQueryReturn<Data> {
1182
+ abort: AbortController['abort'];
1183
+ aborted: boolean;
1165
1184
  data?: Data;
1166
- isLoading: boolean;
1185
+ error?: Error;
1167
1186
  isError: boolean;
1187
+ isLoading: boolean;
1188
+ isRefetching: boolean;
1168
1189
  isSuccess: boolean;
1169
- error?: Error;
1170
1190
  refetch: () => void;
1171
- isRefetching: boolean;
1172
- abort: AbortController['abort'];
1173
- aborted: boolean;
1174
1191
  }
1175
1192
  /**
1176
1193
  * @name useQuery
@@ -1196,20 +1213,20 @@ declare const useQuery: <QueryData, Data = QueryData>(callback: (params: UseQuer
1196
1213
 
1197
1214
  /** The use image options */
1198
1215
  interface UseImageOptions {
1199
- /** The srcset of the image */
1200
- srcset?: string;
1201
- /** The sizes of the image */
1202
- sizes?: string;
1203
1216
  /** The alt of the image */
1204
1217
  alt?: string;
1205
1218
  /** The class of the image */
1206
1219
  class?: string;
1207
- /** The loading of the image */
1208
- loading?: HTMLImageElement['loading'];
1209
1220
  /** The crossorigin of the image */
1210
1221
  crossorigin?: string;
1222
+ /** The loading of the image */
1223
+ loading?: HTMLImageElement['loading'];
1211
1224
  /** The referrer policy of the image */
1212
1225
  referrerPolicy?: HTMLImageElement['referrerPolicy'];
1226
+ /** The sizes of the image */
1227
+ sizes?: string;
1228
+ /** The srcset of the image */
1229
+ srcset?: string;
1213
1230
  }
1214
1231
  /** The use image return type */
1215
1232
  type UseImageReturn = UseQueryReturn<HTMLImageElement>;
@@ -1236,16 +1253,16 @@ type UseImageReturn = UseQueryReturn<HTMLImageElement>;
1236
1253
  * @example
1237
1254
  * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useImage('https://example.com/image.png');
1238
1255
  */
1239
- declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "select" | "initialData" | "placeholderData">) => UseQueryReturn<HTMLImageElement>;
1256
+ declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "initialData" | "placeholderData" | "select">) => UseQueryReturn<HTMLImageElement>;
1240
1257
 
1241
1258
  /** The use infinite scroll target element type */
1242
- type UseInfiniteScrollTarget = RefObject<Element | null> | (() => Element) | Element;
1259
+ type UseInfiniteScrollTarget = (() => Element) | Element | RefObject<Element | null>;
1243
1260
  /** The use infinite scroll options type */
1244
1261
  interface UseInfiniteScrollOptions {
1262
+ /** The direction to trigger the callback */
1263
+ direction?: 'bottom' | 'left' | 'right' | 'top';
1245
1264
  /** The distance in pixels to trigger the callback */
1246
1265
  distance?: number;
1247
- /** The direction to trigger the callback */
1248
- direction?: 'top' | 'bottom' | 'left' | 'right';
1249
1266
  }
1250
1267
  interface UseInfiniteScroll {
1251
1268
  <Target extends UseInfiniteScrollTarget>(target: Target, callback: (event: Event) => void, options?: UseInfiniteScrollOptions): boolean;
@@ -1283,17 +1300,17 @@ interface UseInfiniteScroll {
1283
1300
  declare const useInfiniteScroll: UseInfiniteScroll;
1284
1301
 
1285
1302
  /** The intersection observer target element type */
1286
- type UseIntersectionObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
1303
+ type UseIntersectionObserverTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
1287
1304
  /** The intersection observer options type */
1288
1305
  interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
1289
1306
  enabled?: boolean;
1290
- onChange?: (entry: IntersectionObserverEntry) => void;
1291
1307
  root?: IntersectionObserverInit['root'] | RefObject<Element | null | undefined>;
1308
+ onChange?: (entry: IntersectionObserverEntry) => void;
1292
1309
  }
1293
1310
  /** The intersection observer return type */
1294
1311
  interface UseIntersectionObserverReturn {
1295
- inView: boolean;
1296
1312
  entry?: IntersectionObserverEntry;
1313
+ inView: boolean;
1297
1314
  }
1298
1315
  interface UseIntersectionObserver {
1299
1316
  <Target extends UseIntersectionObserverTarget>(target: Target, options?: UseIntersectionObserverOptions): UseIntersectionObserverReturn;
@@ -1450,10 +1467,10 @@ declare const useKeyPressEvent: UseKeyPressEvent;
1450
1467
 
1451
1468
  /** The use keys pressed params type */
1452
1469
  interface UseKeysPressedParams {
1453
- /** The target to attach the event listeners to */
1454
- target?: UseEventListenerTarget;
1455
1470
  /** Enable or disable the event listeners */
1456
1471
  enabled?: boolean;
1472
+ /** The target to attach the event listeners to */
1473
+ target?: UseEventListenerTarget;
1457
1474
  }
1458
1475
  /**
1459
1476
  * @name useKeysPressed
@@ -1494,18 +1511,18 @@ declare const useLastChanged: (source: any, options?: UseLastChangedOptions) =>
1494
1511
  interface UseListReturn<Item> {
1495
1512
  /** The current list of items */
1496
1513
  value: Item[];
1497
- /** Sets the list of items */
1498
- set: (list: Item[]) => void;
1514
+ /** Clears the list */
1515
+ clear: () => void;
1516
+ /** Inserts an item at the specified index */
1517
+ insertAt: (insertAtIndex: number, item: Item) => void;
1499
1518
  /** Adds an item to the list */
1500
1519
  push: (item: Item) => void;
1501
1520
  /** Removes an item from the list */
1502
1521
  removeAt: (removeAtIndex: number) => void;
1503
- /** Inserts an item at the specified index */
1504
- insertAt: (insertAtIndex: number, item: Item) => void;
1522
+ /** Sets the list of items */
1523
+ set: (list: Item[]) => void;
1505
1524
  /** Updates an item at the specified index */
1506
1525
  updateAt: (updateAtIndex: number, item: Item) => void;
1507
- /** Clears the list */
1508
- clear: () => void;
1509
1526
  }
1510
1527
  /**
1511
1528
  * @name useList
@@ -1530,17 +1547,17 @@ declare const useList: <Item>(initialList?: Item[]) => {
1530
1547
  reset: () => void;
1531
1548
  };
1532
1549
 
1533
- type UseStorageInitialValue<Value> = Value | (() => Value);
1550
+ type UseStorageInitialValue<Value> = (() => Value) | Value;
1534
1551
  interface UseStorageOptions<Value> {
1535
- serializer?: (value: Value) => string;
1536
- deserializer?: (value: string) => Value;
1537
- storage?: Storage;
1538
1552
  initialValue?: UseStorageInitialValue<Value>;
1553
+ storage?: Storage;
1554
+ deserializer?: (value: string) => Value;
1555
+ serializer?: (value: Value) => string;
1539
1556
  }
1540
1557
  interface UseStorageReturn<Value> {
1541
1558
  value: Value;
1542
- set: (value: Value) => void;
1543
1559
  remove: () => void;
1560
+ set: (value: Value) => void;
1544
1561
  }
1545
1562
  declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => boolean;
1546
1563
  /**
@@ -1596,23 +1613,23 @@ declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageIni
1596
1613
  */
1597
1614
  declare const useLogger: (name: string, params: unknown[]) => void;
1598
1615
 
1599
- type UseLongPressTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
1616
+ type UseLongPressTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
1600
1617
  type LongPressReactEvents<Target extends Element = Element> = MouseEventHandler<Target> | TouchEventHandler<Target>;
1601
1618
  interface UseLongPressOptions {
1602
1619
  threshold?: number;
1603
- onStart?: (event: LongPressReactEvents) => void;
1604
- onFinish?: (event: LongPressReactEvents) => void;
1605
1620
  onCancel?: (event: LongPressReactEvents) => void;
1621
+ onFinish?: (event: LongPressReactEvents) => void;
1622
+ onStart?: (event: LongPressReactEvents) => void;
1606
1623
  }
1607
1624
  interface UseLongPressBind {
1608
1625
  /** The callback function to be invoked on mouse down */
1609
1626
  onMouseDown: MouseEventHandler<Element>;
1610
- /** The callback function to be invoked on touch start */
1611
- onTouchStart: TouchEventHandler<Element>;
1612
1627
  /** The callback function to be invoked on mouse up */
1613
1628
  onMouseUp: MouseEventHandler<Element>;
1614
1629
  /** The callback function to be invoked on touch end */
1615
1630
  onTouchEnd: TouchEventHandler<Element>;
1631
+ /** The callback function to be invoked on touch start */
1632
+ onTouchStart: TouchEventHandler<Element>;
1616
1633
  }
1617
1634
  type UseLongPressReturn = [UseLongPressBind, boolean];
1618
1635
  /**
@@ -1636,20 +1653,20 @@ declare const useLongPress: (callback: (event: LongPressReactEvents) => void, op
1636
1653
 
1637
1654
  /** The use map return type */
1638
1655
  interface UseMapReturn<Key, Value> {
1639
- /** The current map */
1640
- value: Map<Key, Value>;
1641
1656
  /** The size of the map */
1642
1657
  size: number;
1658
+ /** The current map */
1659
+ value: Map<Key, Value>;
1660
+ /** Function to clear the map */
1661
+ clear: () => void;
1643
1662
  /** Function to check if a value exists in the map */
1644
1663
  has: (key: Key) => boolean;
1645
- /** Function to add a value to the map */
1646
- set: (key: Key, value: Value) => void;
1647
1664
  /** Function to remove a value from the map */
1648
1665
  remove: (key: Key) => void;
1649
- /** Function to clear the map */
1650
- clear: () => void;
1651
1666
  /** Function to toggle a value in the map */
1652
1667
  reset: () => void;
1668
+ /** Function to add a value to the map */
1669
+ set: (key: Key, value: Value) => void;
1653
1670
  }
1654
1671
  /**
1655
1672
  * @name useMap
@@ -1666,9 +1683,9 @@ interface UseMapReturn<Key, Value> {
1666
1683
  declare const useMap: <Key, Value>(values?: [Key, Value][]) => UseMapReturn<Key, Value>;
1667
1684
 
1668
1685
  /** The use measure target element type */
1669
- type UseMeasureTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
1686
+ type UseMeasureTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
1670
1687
  /** The use measure return type */
1671
- type UseMeasureReturn = Pick<DOMRectReadOnly, 'x' | 'y' | 'top' | 'left' | 'right' | 'bottom' | 'height' | 'width'>;
1688
+ type UseMeasureReturn = Pick<DOMRectReadOnly, 'bottom' | 'height' | 'left' | 'right' | 'top' | 'width' | 'x' | 'y'>;
1672
1689
  interface UseMeasureScreen {
1673
1690
  <Target extends UseMeasureTarget>(target: Target): UseMeasureReturn;
1674
1691
  <Target extends UseMeasureTarget>(target?: never): UseMeasureReturn & {
@@ -1751,23 +1768,23 @@ declare const useMemory: () => UseMemoryReturn;
1751
1768
  declare const useMount: (effect: EffectCallback) => void;
1752
1769
 
1753
1770
  /** The use mouse target element type */
1754
- type UseMouseTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
1771
+ type UseMouseTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
1755
1772
  /** The use mouse return type */
1756
1773
  interface UseMouseReturn {
1757
- /** The current mouse x position */
1758
- x: number;
1759
- /** The current mouse y position */
1760
- y: number;
1761
1774
  /** The current element */
1762
1775
  element: Element;
1763
- /** The current element x position */
1764
- elementX: number;
1765
- /** The current element y position */
1766
- elementY: number;
1767
1776
  /** The current element position x */
1768
1777
  elementPositionX: number;
1769
1778
  /** The current element position y */
1770
1779
  elementPositionY: number;
1780
+ /** The current element x position */
1781
+ elementX: number;
1782
+ /** The current element y position */
1783
+ elementY: number;
1784
+ /** The current mouse x position */
1785
+ x: number;
1786
+ /** The current mouse y position */
1787
+ y: number;
1771
1788
  }
1772
1789
  interface UseMouse {
1773
1790
  <Target extends UseMouseTarget>(target: Target): UseMouseReturn;
@@ -1798,19 +1815,19 @@ interface UseMouse {
1798
1815
  declare const useMouse: UseMouse;
1799
1816
 
1800
1817
  interface UseMutationOptions<Data> {
1801
- retry?: boolean | number | ((failureCount: number, error: Error) => boolean);
1802
- retryDelay?: number | ((retry: number, error: Error) => number);
1803
- onSuccess?: (data: Data) => void;
1818
+ retry?: ((failureCount: number, error: Error) => boolean) | boolean | number;
1819
+ retryDelay?: ((retry: number, error: Error) => number) | number;
1804
1820
  onError?: (error: Error) => void;
1821
+ onSuccess?: (data: Data) => void;
1805
1822
  }
1806
1823
  interface UseMutationReturn<Body, Data> {
1807
1824
  data: Data | null;
1808
1825
  error: Error | null;
1809
- mutate: (body?: Body, options?: UseMutationOptions<Data>) => void;
1810
- mutateAsync: (body?: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
1811
- isLoading: boolean;
1812
1826
  isError: boolean;
1827
+ isLoading: boolean;
1813
1828
  isSuccess: boolean;
1829
+ mutate: (body?: Body, options?: UseMutationOptions<Data>) => void;
1830
+ mutateAsync: (body?: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
1814
1831
  }
1815
1832
  interface RequestOptions<Data> extends UseMutationOptions<Data> {
1816
1833
  attempt?: number;
@@ -1834,13 +1851,13 @@ interface RequestOptions<Data> extends UseMutationOptions<Data> {
1834
1851
  declare const useMutation: <Body, Data>(callback: (body: Body) => Promise<Data>, options?: UseMutationOptions<Data>) => UseMutationReturn<Body, Data>;
1835
1852
 
1836
1853
  /** The mutation observer target element type */
1837
- type UseMutationObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
1854
+ type UseMutationObserverTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
1838
1855
  /** The mutation observer return type */
1839
1856
  interface UseMutationObserverReturn {
1840
- /** The mutation observer entries */
1841
- stop: () => void;
1842
1857
  /** The mutation observer instance */
1843
1858
  observer: MutationObserver;
1859
+ /** The mutation observer entries */
1860
+ stop: () => void;
1844
1861
  }
1845
1862
  /** The mutation observer options type */
1846
1863
  interface UseMutationObserverOptions extends MutationObserverInit {
@@ -1896,11 +1913,11 @@ declare const useMutationObserver: UseMutationObserver;
1896
1913
  interface Connection extends EventTarget {
1897
1914
  readonly downlink: number;
1898
1915
  readonly downlinkMax: number;
1899
- readonly effectiveType: 'slow-2g' | '2g' | '3g' | '4g';
1916
+ readonly effectiveType: '2g' | '3g' | '4g' | 'slow-2g';
1900
1917
  readonly rtt: number;
1901
1918
  readonly saveData: boolean;
1902
- readonly type: 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi' | 'wimax';
1903
1919
  onChange: (event: Event) => void;
1920
+ readonly type: 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi' | 'wimax';
1904
1921
  }
1905
1922
  declare global {
1906
1923
  interface Navigator {
@@ -1915,14 +1932,14 @@ type ConnectionType = Connection['type'];
1915
1932
  type ConnectionEffectiveType = Connection['effectiveType'];
1916
1933
  /** The use network return type */
1917
1934
  interface UseNetworkReturn {
1918
- /** Indicates if the device is currently online */
1919
- online: boolean;
1920
1935
  /** The estimated downlink speed in megabits per seconds */
1921
1936
  downlink?: Connection['downlink'];
1922
1937
  /** The maximum downlink speed, if available */
1923
1938
  downlinkMax?: Connection['downlinkMax'];
1924
1939
  /** The effective type of connection (e.g., '2g', '3g', '4g') */
1925
1940
  effectiveType?: Connection['effectiveType'];
1941
+ /** Indicates if the device is currently online */
1942
+ online: boolean;
1926
1943
  /** The estimated round-trip time in milliseconds */
1927
1944
  rtt?: Connection['rtt'];
1928
1945
  /** Indicates if the user has enabled data saving mode */
@@ -1945,44 +1962,44 @@ declare const useNetwork: () => UseNetworkReturn;
1945
1962
 
1946
1963
  /** The use offset pagination return type */
1947
1964
  interface UseOffsetPaginationOptions {
1948
- /** The total number of items */
1949
- total?: number;
1950
- /** The number of items per page */
1951
- pageSize?: number;
1952
1965
  /** The initial page number */
1953
1966
  initialPage?: number;
1967
+ /** The number of items per page */
1968
+ pageSize?: number;
1969
+ /** The total number of items */
1970
+ total?: number;
1954
1971
  /** The callback function to be invoked when page changes */
1955
1972
  onPageChange?: ({ page, pageSize }: {
1956
1973
  page: number;
1957
1974
  pageSize: number;
1958
1975
  }) => void;
1959
- /** The callback function to be invoked when page size changes */
1960
- onPageSizeChange?: ({ page, pageSize }: {
1976
+ /** The callback function to be invoked when page count changes */
1977
+ onPageCountChange?: ({ page, pageSize }: {
1961
1978
  page: number;
1962
1979
  pageSize: number;
1963
1980
  }) => void;
1964
- /** The callback function to be invoked when page count changes */
1965
- onPageCountChange?: ({ page, pageSize }: {
1981
+ /** The callback function to be invoked when page size changes */
1982
+ onPageSizeChange?: ({ page, pageSize }: {
1966
1983
  page: number;
1967
1984
  pageSize: number;
1968
1985
  }) => void;
1969
1986
  }
1970
1987
  /** The use offset pagination return type */
1971
1988
  interface UseOffsetPaginationReturn {
1972
- /** The current page number */
1973
- page: number;
1974
1989
  /** The number of items per page */
1975
1990
  currentPageSize: number;
1976
- /** The total number of pages */
1977
- pageCount: number;
1978
1991
  /** Whether the current page is the first page */
1979
1992
  isFirstPage: boolean;
1980
1993
  /** Whether the current page is the last page */
1981
1994
  isLastPage: boolean;
1982
- /** The callback function to go to the previous page */
1983
- prev: () => void;
1995
+ /** The current page number */
1996
+ page: number;
1997
+ /** The total number of pages */
1998
+ pageCount: number;
1984
1999
  /** The callback function to go to the next page */
1985
2000
  next: () => void;
2001
+ /** The callback function to go to the previous page */
2002
+ prev: () => void;
1986
2003
  /** The callback function to set the current page */
1987
2004
  set: (page: number) => void;
1988
2005
  }
@@ -2025,7 +2042,7 @@ declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange
2025
2042
  declare const useOnline: () => boolean;
2026
2043
 
2027
2044
  /** The operating system type */
2028
- type OperatingSystem = 'undetermined' | 'macos' | 'ios' | 'windows' | 'android' | 'linux';
2045
+ type OperatingSystem = 'android' | 'ios' | 'linux' | 'macos' | 'undetermined' | 'windows';
2029
2046
  declare const getOperatingSystem: () => OperatingSystem;
2030
2047
  /**
2031
2048
  * @name useOperatingSystem
@@ -2090,14 +2107,14 @@ declare global {
2090
2107
  }
2091
2108
  type UseOtpCredentialCallback = (otp: Credential | null) => void;
2092
2109
  interface UseOtpCredentialParams {
2093
- onSuccess: (credential: Credential | null) => void;
2094
2110
  onError: (error: any) => void;
2111
+ onSuccess: (credential: Credential | null) => void;
2095
2112
  }
2096
2113
  interface UseOtpCredentialReturn {
2097
- supported: boolean;
2098
- get: () => Promise<Credential | null>;
2099
2114
  abort: AbortController['abort'];
2100
2115
  aborted: boolean;
2116
+ supported: boolean;
2117
+ get: () => Promise<Credential | null>;
2101
2118
  }
2102
2119
  interface UseOtpCredential {
2103
2120
  (callback?: UseOtpCredentialCallback): UseOtpCredentialReturn;
@@ -2186,14 +2203,14 @@ declare class Paint {
2186
2203
  interface UsePaintOptions {
2187
2204
  /** Brush color */
2188
2205
  color?: string;
2206
+ /** Initial lines */
2207
+ initialLines?: Paint['lines'];
2208
+ /** Brush opacity */
2209
+ opacity?: number;
2189
2210
  /** Brush radius */
2190
2211
  radius?: number;
2191
2212
  /** Smooth brush movement */
2192
2213
  smooth?: boolean;
2193
- /** Brush opacity */
2194
- opacity?: number;
2195
- /** Initial lines */
2196
- initialLines?: Paint['lines'];
2197
2214
  /** Callback when the mouse is down */
2198
2215
  onMouseDown?: (event: MouseEvent, paint: Paint) => void;
2199
2216
  /** Callback when the mouse is moved */
@@ -2203,13 +2220,13 @@ interface UsePaintOptions {
2203
2220
  }
2204
2221
  interface UsePaintReturn {
2205
2222
  drawing: boolean;
2223
+ lines: Paint['lines'];
2206
2224
  clear: () => void;
2207
- undo: () => void;
2208
2225
  draw: (points: Point[], color: string, opacity: number, radius: number) => void;
2209
- lines: Paint['lines'];
2226
+ undo: () => void;
2210
2227
  }
2211
2228
  /** The use paint return type */
2212
- type UsePaintTarget = RefObject<HTMLCanvasElement> | (() => HTMLCanvasElement) | HTMLCanvasElement;
2229
+ type UsePaintTarget = (() => HTMLCanvasElement) | HTMLCanvasElement | RefObject<HTMLCanvasElement>;
2213
2230
  interface UsePaint {
2214
2231
  <Target extends UsePaintTarget>(target: Target, options?: UsePaintOptions): UsePaintReturn;
2215
2232
  (options?: UsePaintOptions, target?: never): {
@@ -2243,21 +2260,21 @@ declare const usePaint: UsePaint;
2243
2260
  interface UseParallaxValue {
2244
2261
  /** Roll value. Scaled to `-0.5 ~ 0.5` */
2245
2262
  roll: number;
2246
- /** Tilt value. Scaled to `-0.5 ~ 0.5` */
2247
- tilt: number;
2248
2263
  /** Sensor source, can be `mouse` or `deviceOrientation` */
2249
2264
  source: 'deviceOrientation' | 'mouse';
2265
+ /** Tilt value. Scaled to `-0.5 ~ 0.5` */
2266
+ tilt: number;
2250
2267
  }
2251
2268
  /** The use parallax options type */
2252
2269
  interface UseParallaxOptions {
2253
- /** Device orientation tilt adjust function */
2254
- deviceOrientationTiltAdjust?: (value: number) => number;
2255
2270
  /** Device orientation roll adjust function */
2256
2271
  deviceOrientationRollAdjust?: (value: number) => number;
2257
- /** Mouse tilt adjust function */
2258
- mouseTiltAdjust?: (value: number) => number;
2272
+ /** Device orientation tilt adjust function */
2273
+ deviceOrientationTiltAdjust?: (value: number) => number;
2259
2274
  /** Mouse roll adjust function */
2260
2275
  mouseRollAdjust?: (value: number) => number;
2276
+ /** Mouse tilt adjust function */
2277
+ mouseTiltAdjust?: (value: number) => number;
2261
2278
  }
2262
2279
  interface UseParallaxReturn {
2263
2280
  value: UseParallaxValue;
@@ -2292,7 +2309,7 @@ interface UseParallax {
2292
2309
  declare const useParallax: UseParallax;
2293
2310
 
2294
2311
  /** The permission name */
2295
- type UsePermissionName = PermissionName | 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker';
2312
+ type UsePermissionName = 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker' | PermissionName;
2296
2313
  /** The use permission options type */
2297
2314
  interface UsePermissionOptions {
2298
2315
  /** Whether the permission is enabled */
@@ -2312,6 +2329,8 @@ interface UsePermissionReturn {
2312
2329
  * @description - Hook that gives you the state of permission
2313
2330
  * @category Browser
2314
2331
  *
2332
+ * @param {UsePermissionName} permissionDescriptorName - The permission name
2333
+ * @param {boolean} [options.enabled=true] - Whether the permission is enabled
2315
2334
  * @returns {UsePermissionReturn} An object containing the state and the supported status
2316
2335
  *
2317
2336
  * @example
@@ -2323,6 +2342,26 @@ declare const usePermission: (permissionDescriptorName: UsePermissionName, optio
2323
2342
  query: () => Promise<PermissionState>;
2324
2343
  };
2325
2344
 
2345
+ type UsePointerLockTarget = RefObject<Element | null | undefined>;
2346
+ interface UsePointerLockReturn {
2347
+ element?: Element;
2348
+ supported: boolean;
2349
+ lock: (event: Event | MouseEvent$1<Element>) => void;
2350
+ unlock: () => boolean;
2351
+ }
2352
+ /**
2353
+ * @name usePointerLock
2354
+ * @description Hook that provides reactive pointer lock
2355
+ * @category Sensors
2356
+ *
2357
+ * @param {UsePointerLockTarget} target The target element for the pointer lock
2358
+ * @returns {UsePointerLockReturn} An object containing the pointer lock element and functions to interact with the pointer lock
2359
+ *
2360
+ * @example
2361
+ * const { supported, lock, unlock, element } = usePointerLock();
2362
+ */
2363
+ declare const usePointerLock: (target?: UsePointerLockTarget) => UsePointerLockReturn;
2364
+
2326
2365
  /** The use preferred color scheme return type */
2327
2366
  type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
2328
2367
  /**
@@ -2338,7 +2377,7 @@ type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
2338
2377
  declare const usePreferredColorScheme: () => UsePreferredColorSchemeReturn;
2339
2378
 
2340
2379
  /** The use preferred contrast return type */
2341
- type UsePreferredContrastReturn = 'more' | 'less' | 'custom' | 'no-preference';
2380
+ type UsePreferredContrastReturn = 'custom' | 'less' | 'more' | 'no-preference';
2342
2381
  /**
2343
2382
  * @name usePreferredContrast
2344
2383
  * @description - Hook that returns the contrast preference
@@ -2374,7 +2413,7 @@ declare const usePreferredDark: () => boolean;
2374
2413
  declare const usePreferredLanguages: () => readonly string[];
2375
2414
 
2376
2415
  /** The use preferred reduced motion return type */
2377
- type UsePreferredReducedMotionReturn = 'reduce' | 'no-preference';
2416
+ type UsePreferredReducedMotionReturn = 'no-preference' | 'reduce';
2378
2417
  /**
2379
2418
  * @name usePreferredReducedMotion
2380
2419
  * @description - Hook that returns the reduced motion preference
@@ -2403,20 +2442,20 @@ declare const usePrevious: <Value>(value: Value) => Value | undefined;
2403
2442
 
2404
2443
  /** The use queue return type */
2405
2444
  interface UseQueueReturn<Value> {
2406
- /** The current queue */
2407
- queue: Value[];
2408
- /** Add an element to the queue */
2409
- add: (element: Value) => void;
2410
- /** Remove an element from the queue */
2411
- remove: () => Value;
2412
- /** Clear the queue */
2413
- clear: () => void;
2414
2445
  /** Get the first element of the queue */
2415
2446
  first: Value;
2416
2447
  /** Get the last element of the queue */
2417
2448
  last: Value;
2449
+ /** The current queue */
2450
+ queue: Value[];
2418
2451
  /** Get the size of the queue */
2419
2452
  size: number;
2453
+ /** Add an element to the queue */
2454
+ add: (element: Value) => void;
2455
+ /** Clear the queue */
2456
+ clear: () => void;
2457
+ /** Remove an element from the queue */
2458
+ remove: () => Value;
2420
2459
  }
2421
2460
  /**
2422
2461
  * @name useQueue
@@ -2481,7 +2520,7 @@ type UseRafValueReturn<Value> = [Value, (value: Value) => void];
2481
2520
  * @example
2482
2521
  * const [value, setValue] = useRafValue(initialValue);
2483
2522
  */
2484
- declare const useRafValue: <Value>(initialValue: Value | (() => Value)) => readonly [Value, (value: Value) => void];
2523
+ declare const useRafValue: <Value>(initialValue: (() => Value) | Value) => readonly [Value, (value: Value) => void];
2485
2524
 
2486
2525
  /**
2487
2526
  * @name useRenderCount
@@ -2498,8 +2537,8 @@ declare const useRenderCount: () => number;
2498
2537
  interface UseRenderInfoReturn {
2499
2538
  component: string;
2500
2539
  renders: number;
2501
- timestamp: null | number;
2502
2540
  sinceLast: number;
2541
+ timestamp: number | null;
2503
2542
  }
2504
2543
  /**
2505
2544
  * @name useRenderInfo
@@ -2535,7 +2574,7 @@ interface UseRerenderReturns {
2535
2574
  declare const useRerender: () => UseRerenderReturns;
2536
2575
 
2537
2576
  /** The resize observer target element type */
2538
- type UseResizeObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
2577
+ type UseResizeObserverTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
2539
2578
  /** The resize observer options type */
2540
2579
  interface UseResizeObserverOptions extends ResizeObserverOptions {
2541
2580
  enabled?: boolean;
@@ -2590,7 +2629,7 @@ interface UseScreenOrientationValue {
2590
2629
  /** The current orientation type */
2591
2630
  orientationType: OrientationType;
2592
2631
  }
2593
- type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
2632
+ type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
2594
2633
  interface useScreenOrientationReturn {
2595
2634
  /** Whether the screen orientation is supported */
2596
2635
  supported: boolean;
@@ -2614,7 +2653,7 @@ interface useScreenOrientationReturn {
2614
2653
  declare const useScreenOrientation: () => useScreenOrientationReturn;
2615
2654
 
2616
2655
  /** The use script status */
2617
- type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
2656
+ type UseScriptStatus = 'error' | 'loading' | 'ready' | 'unknown';
2618
2657
  declare const SCRIPT_STATUS_ATTRIBUTE_NAME = "script-status";
2619
2658
  /** The use script options extends from attributes script tag */
2620
2659
  interface UseScriptOptions extends ComponentProps<'script'> {
@@ -2658,30 +2697,30 @@ declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageI
2658
2697
 
2659
2698
  /** The use set return type */
2660
2699
  interface UseSetReturn<Value> {
2661
- /** The current set */
2662
- value: Set<Value>;
2663
2700
  /** The size of the set */
2664
2701
  size: number;
2665
- /** Function to check if a value exists in the set */
2666
- has: (value: Value) => boolean;
2702
+ /** The current set */
2703
+ value: Set<Value>;
2667
2704
  /** Function to add a value to the set */
2668
2705
  add: (value: Value) => void;
2669
- /** Function to remove a value from the set */
2670
- remove: (value: Value) => void;
2671
2706
  /** Function to clear the set */
2672
2707
  clear: () => void;
2708
+ /** Function to get the symmetric difference of two sets */
2709
+ difference: (other: Set<Value>) => void;
2710
+ /** Function to check if a value exists in the set */
2711
+ has: (value: Value) => boolean;
2712
+ /** Function to get the difference of two sets */
2713
+ intersection: (other: Set<Value>) => void;
2714
+ /** Function to remove a value from the set */
2715
+ remove: (value: Value) => void;
2673
2716
  /** Function to toggle a value in the set */
2674
2717
  reset: () => void;
2718
+ /** Function to get the symmetric difference of two sets */
2719
+ symmetricDifference: (other: Set<Value>) => void;
2675
2720
  /** Function to toggle a value in the set */
2676
2721
  toggle: (value: Value) => void;
2677
2722
  /** Function to get the union of two sets */
2678
2723
  union: (other: Set<Value>) => void;
2679
- /** Function to get the difference of two sets */
2680
- intersection: (other: Set<Value>) => void;
2681
- /** Function to get the symmetric difference of two sets */
2682
- difference: (other: Set<Value>) => void;
2683
- /** Function to get the symmetric difference of two sets */
2684
- symmetricDifference: (other: Set<Value>) => void;
2685
2724
  }
2686
2725
  /**
2687
2726
  * @name useSet
@@ -2699,21 +2738,21 @@ declare const useSet: <Value>(values?: Value[]) => UseSetReturn<Value>;
2699
2738
 
2700
2739
  /** The use share options type */
2701
2740
  interface UseShareParams {
2702
- /** The title of the share */
2703
- title?: string;
2704
2741
  /** The files of the share */
2705
2742
  files?: File[];
2706
2743
  /** The text of the share */
2707
2744
  text?: string;
2745
+ /** The title of the share */
2746
+ title?: string;
2708
2747
  /** The url of the share */
2709
2748
  url?: string;
2710
2749
  }
2711
2750
  /** The use share return type */
2712
2751
  interface UseShareReturn {
2713
- /** The share function */
2714
- share: (shareParams: ShareData) => Promise<void>;
2715
2752
  /** The share supported status */
2716
2753
  supported: boolean;
2754
+ /** The share function */
2755
+ share: (shareParams: ShareData) => Promise<void>;
2717
2756
  }
2718
2757
  /**
2719
2758
  * @name useShare
@@ -2748,14 +2787,14 @@ interface UseStepReturn {
2748
2787
  isFirst: boolean;
2749
2788
  /** Boolean value if current step is last */
2750
2789
  isLast: boolean;
2751
- /** Go to next step */
2752
- next: () => void;
2753
2790
  /** Go to back step */
2754
2791
  back: () => void;
2792
+ /** Go to next step */
2793
+ next: () => void;
2755
2794
  /** Reset current step to initial value */
2756
2795
  reset: () => void;
2757
2796
  /** Go to custom step */
2758
- set: (value: number | 'last' | 'first') => void;
2797
+ set: (value: number | 'first' | 'last') => void;
2759
2798
  }
2760
2799
  /**
2761
2800
  * @name useStep
@@ -2781,26 +2820,26 @@ declare const useStep: (params: number | UseStepParams) => UseStepReturn;
2781
2820
 
2782
2821
  /** The use stopwatch return type */
2783
2822
  interface UseStopwatchReturn {
2784
- /** The paused state of the stopwatch */
2785
- paused: boolean;
2786
- /** The over state of the stopwatch */
2787
- over: boolean;
2823
+ /** The total count of the stopwatch */
2824
+ count: number;
2788
2825
  /** The day count of the stopwatch */
2789
2826
  days: number;
2790
2827
  /** The hour count of the stopwatch */
2791
2828
  hours: number;
2792
2829
  /** The minute count of the stopwatch */
2793
2830
  minutes: number;
2831
+ /** The over state of the stopwatch */
2832
+ over: boolean;
2833
+ /** The paused state of the stopwatch */
2834
+ paused: boolean;
2794
2835
  /** The second count of the stopwatch */
2795
2836
  seconds: number;
2796
- /** The total count of the stopwatch */
2797
- count: number;
2798
2837
  /** The function to pause the stopwatch */
2799
2838
  pause: () => void;
2800
- /** The function to start the stopwatch */
2801
- start: () => void;
2802
2839
  /** The function to reset the stopwatch */
2803
2840
  reset: () => void;
2841
+ /** The function to start the stopwatch */
2842
+ start: () => void;
2804
2843
  /** The function to toggle the stopwatch */
2805
2844
  toggle: () => void;
2806
2845
  }
@@ -2841,14 +2880,14 @@ declare const useStopwatch: UseStopwatch;
2841
2880
  declare const getRangesSelection: (selection: Selection) => Range[];
2842
2881
  /** The use text selection return type */
2843
2882
  interface UseTextSelectionReturn {
2844
- /** The current selection text */
2845
- text: string;
2846
2883
  /** The current selection ranges */
2847
2884
  ranges: Range[];
2848
2885
  /** The current selection rects */
2849
2886
  rects: DOMRect[];
2850
2887
  /** The current selection */
2851
2888
  selection: Selection | null;
2889
+ /** The current selection text */
2890
+ text: string;
2852
2891
  }
2853
2892
  /**
2854
2893
  * @name useTextSelection
@@ -2863,17 +2902,17 @@ interface UseTextSelectionReturn {
2863
2902
  declare const useTextSelection: () => UseTextSelectionReturn;
2864
2903
 
2865
2904
  interface UseTimeReturn {
2866
- seconds: number;
2867
- minutes: number;
2905
+ day: number;
2868
2906
  hours: number;
2869
2907
  meridiemHours: {
2870
2908
  value: number;
2871
2909
  type: string;
2872
2910
  };
2873
- day: number;
2911
+ minutes: number;
2874
2912
  month: number;
2875
- year: number;
2913
+ seconds: number;
2876
2914
  timestamp: number;
2915
+ year: number;
2877
2916
  }
2878
2917
  /**
2879
2918
  * @name useTime
@@ -2923,22 +2962,22 @@ interface UseTimerOptions {
2923
2962
  }
2924
2963
  /** The use timer return type */
2925
2964
  interface UseTimerReturn {
2926
- /** flag to indicate if timer is running or not */
2927
- running: boolean;
2928
2965
  /** The day count of the timer */
2929
2966
  days: number;
2930
2967
  /** The hour count of the timer */
2931
2968
  hours: number;
2932
2969
  /** The minute count of the timer */
2933
2970
  minutes: number;
2971
+ /** flag to indicate if timer is running or not */
2972
+ running: boolean;
2934
2973
  /** The second count of the timer */
2935
2974
  seconds: number;
2936
2975
  /** The function to pause the timer */
2937
2976
  pause: () => void;
2938
- /** The function to start the timer */
2939
- start: () => void;
2940
2977
  /** The function to restart the timer */
2941
2978
  restart: (time: number, autostart?: boolean) => void;
2979
+ /** The function to start the timer */
2980
+ start: () => void;
2942
2981
  /** The function to toggle the timer */
2943
2982
  toggle: () => void;
2944
2983
  }
@@ -2988,22 +3027,22 @@ declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonl
2988
3027
  */
2989
3028
  declare const useUnmount: (callback: () => void) => void;
2990
3029
 
2991
- type UseWebSocketUrl = string | (() => string);
3030
+ type UseWebSocketUrl = (() => string) | string;
2992
3031
  interface UseWebSocketOptions {
3032
+ protocols?: Array<'soap' | 'wasm'>;
3033
+ retry?: boolean | number;
2993
3034
  onConnected?: (webSocket: WebSocket) => void;
2994
3035
  onDisconnected?: (event: CloseEvent, webSocket: WebSocket) => void;
2995
3036
  onError?: (event: Event, webSocket: WebSocket) => void;
2996
3037
  onMessage?: (event: MessageEvent, webSocket: WebSocket) => void;
2997
- retry?: boolean | number;
2998
- protocols?: Array<'soap' | 'wasm'>;
2999
3038
  }
3000
- type UseWebSocketStatus = 'connecting' | 'failed' | 'connected' | 'disconnected';
3039
+ type UseWebSocketStatus = 'connected' | 'connecting' | 'disconnected' | 'failed';
3001
3040
  interface UseWebSocketReturn {
3002
- status: UseWebSocketStatus;
3041
+ client?: WebSocket;
3003
3042
  close: WebSocket['close'];
3004
3043
  send: WebSocket['send'];
3044
+ status: UseWebSocketStatus;
3005
3045
  open: () => void;
3006
- client?: WebSocket;
3007
3046
  }
3008
3047
  /**
3009
3048
  * @name useWebSocket
@@ -3040,6 +3079,18 @@ declare const useWebSocket: (url: UseWebSocketUrl, options?: UseWebSocketOptions
3040
3079
  */
3041
3080
  declare const useWindowEvent: <Event extends keyof WindowEventMap>(event: Event, listener: (this: Window, event: WindowEventMap[Event]) => any, options?: UseEventListenerOptions) => void;
3042
3081
 
3082
+ /**
3083
+ * @name useWindowFocus
3084
+ * @description - Hook that provides the current focus state of the window
3085
+ * @category Elements
3086
+ *
3087
+ * @returns {boolean} The current focus state of the window
3088
+ *
3089
+ * @example
3090
+ * const focused = useWindowFocus();
3091
+ */
3092
+ declare const useWindowFocus: () => boolean;
3093
+
3043
3094
  interface ScrollPosition {
3044
3095
  x: number;
3045
3096
  y: number;
@@ -3067,15 +3118,15 @@ interface UseWindowSizeParams {
3067
3118
  }
3068
3119
  /** The use window size return type */
3069
3120
  interface UseWindowSizeReturn {
3070
- /** The current window width */
3071
- width: number;
3072
3121
  /** The current window height */
3073
3122
  height: number;
3123
+ /** The current window width */
3124
+ width: number;
3074
3125
  }
3075
3126
  /**
3076
3127
  * @name useWindowSize
3077
3128
  * @description - Hook that manages a window size
3078
- * @category Browser
3129
+ * @category Elements
3079
3130
  *
3080
3131
  * @param {number} [params.initialWidth=Number.POSITIVE_INFINITY] The initial window width
3081
3132
  * @param {number} [params.initialHeight=Number.POSITIVE_INFINITY] The initial window height
@@ -3119,10 +3170,10 @@ declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardSte
3119
3170
 
3120
3171
  declare function debounce<Params extends unknown[]>(callback: (...args: Params) => void, delay: number): (...args: Params) => void;
3121
3172
 
3122
- type GetElementTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
3173
+ type GetElementTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
3123
3174
  declare const getElement: <Target extends GetElementTarget>(target: Target) => Element | (Target & Document) | (Target & Window) | null | undefined;
3124
3175
 
3125
- declare const getRetry: (retry: number | boolean) => number;
3176
+ declare const getRetry: (retry: boolean | number) => number;
3126
3177
 
3127
3178
  declare const isClient: boolean;
3128
3179
 
@@ -3142,4 +3193,4 @@ declare const getDate: (now?: Date) => {
3142
3193
  timestamp: number;
3143
3194
  };
3144
3195
 
3145
- export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type UseAsyncReturn, type UseBatteryStateReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFocus, type UseFocusOptions, type UseFocusReturn, type UseFocusTarget, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseLastChangedOptions, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UseParallax, type UseParallaxOptions, type UseParallaxValue, type UsePermissionName, type UsePermissionOptions, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFocus, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useLastChanged, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useTimer, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowScroll, useWindowSize, useWizard };
3196
+ 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 UseBatteryValue, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFocus, type UseFocusOptions, type UseFocusReturn, type UseFocusTarget, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseLastChangedOptions, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UseParallax, type UseParallaxOptions, type UseParallaxValue, type UsePermissionName, type UsePermissionOptions, type UsePermissionReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useActiveElement, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFocus, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useLastChanged, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePointerLock, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useTimer, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowFocus, useWindowScroll, useWindowSize, useWizard };