@siberiacancode/reactuse 0.0.99 → 0.0.101

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 (370) hide show
  1. package/dist/cjs/{_rollupPluginBabelHelpers-C-GU1yny.js → _rollupPluginBabelHelpers-Cly5x9-o.js} +2 -2
  2. package/dist/cjs/_rollupPluginBabelHelpers-Cly5x9-o.js.map +1 -0
  3. package/dist/cjs/hooks/index.js +2 -2
  4. package/dist/cjs/hooks/useActiveElement/useActiveElement.js +2 -2
  5. package/dist/cjs/hooks/useAsync/useAsync.js +2 -2
  6. package/dist/cjs/hooks/useBattery/useBattery.js +2 -2
  7. package/dist/cjs/hooks/useBattery/useBattery.js.map +1 -1
  8. package/dist/cjs/hooks/useBluetooth/useBluetooth.js +2 -2
  9. package/dist/cjs/hooks/useBluetooth/useBluetooth.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/useBreakpoints.js +2 -2
  13. package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  14. package/dist/cjs/hooks/useBrowserLanguage/useBrowserLanguage.js.map +1 -1
  15. package/dist/cjs/hooks/useClickOutside/useClickOutside.js +2 -2
  16. package/dist/cjs/hooks/useClipboard/useClipboard.js +2 -2
  17. package/dist/cjs/hooks/useClipboard/useClipboard.js.map +1 -1
  18. package/dist/cjs/hooks/useConst/useConst.js +1 -1
  19. package/dist/cjs/hooks/useCookie/useCookie.js +2 -2
  20. package/dist/cjs/hooks/useCookie/useCookie.js.map +1 -1
  21. package/dist/cjs/hooks/useCookies/useCookies.js +2 -2
  22. package/dist/cjs/hooks/useCounter/useCounter.js +2 -2
  23. package/dist/cjs/hooks/useCounter/useCounter.js.map +1 -1
  24. package/dist/cjs/hooks/useCssVar/useCssVar.js +2 -2
  25. package/dist/cjs/hooks/useCssVar/useCssVar.js.map +1 -1
  26. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  27. package/dist/cjs/hooks/useDebounceCallback/useDebounceCallback.js.map +1 -1
  28. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.js +2 -2
  29. package/dist/cjs/hooks/useDebounceValue/useDebounceValue.js.map +1 -1
  30. package/dist/cjs/hooks/useDefault/useDefault.js +2 -2
  31. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js +2 -2
  32. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -1
  33. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js +2 -2
  34. package/dist/cjs/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -1
  35. package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.js +2 -2
  36. package/dist/cjs/hooks/useDevicePixelRatio/useDevicePixelRatio.js.map +1 -1
  37. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.js +1 -1
  38. package/dist/cjs/hooks/useDidUpdate/useDidUpdate.js.map +1 -1
  39. package/dist/cjs/hooks/useDisclosure/useDisclosure.js +2 -2
  40. package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.js +2 -2
  41. package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.js.map +1 -1
  42. package/dist/cjs/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  43. package/dist/cjs/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  44. package/dist/cjs/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  45. package/dist/cjs/hooks/useElementSize/useElementSize.js +2 -2
  46. package/dist/cjs/hooks/useEvent/useEvent.js +1 -1
  47. package/dist/cjs/hooks/useEventListener/useEventListener.js +2 -2
  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/useField/useField.js +2 -2
  52. package/dist/cjs/hooks/useFileDialog/useFileDialog.js +2 -2
  53. package/dist/cjs/hooks/useFocus/useFocus.js +2 -2
  54. package/dist/cjs/hooks/useFps/useFps.js +2 -2
  55. package/dist/cjs/hooks/useFps/useFps.js.map +1 -1
  56. package/dist/cjs/hooks/useFullscreen/useFullscreen.js +2 -2
  57. package/dist/cjs/hooks/useGamepad/useGamepad.js +2 -2
  58. package/dist/cjs/hooks/useGamepad/useGamepad.js.map +1 -1
  59. package/dist/cjs/hooks/useGeolocation/useGeolocation.js +2 -2
  60. package/dist/cjs/hooks/useGeolocation/useGeolocation.js.map +1 -1
  61. package/dist/cjs/hooks/useHash/useHash.js +2 -2
  62. package/dist/cjs/hooks/useHotkeys/useHotkeys.js +2 -2
  63. package/dist/cjs/hooks/useHover/useHover.js +2 -2
  64. package/dist/cjs/hooks/useIdle/useIdle.js +2 -2
  65. package/dist/cjs/hooks/useImage/useImage.js +2 -2
  66. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  67. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  68. package/dist/cjs/hooks/useInterval/useInterval.js +2 -2
  69. package/dist/cjs/hooks/useInterval/useInterval.js.map +1 -1
  70. package/dist/cjs/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  71. package/dist/cjs/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  72. package/dist/cjs/hooks/useKeyPress/useKeyPress.js +2 -2
  73. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  74. package/dist/cjs/hooks/useKeyboard/useKeyboard.js +2 -2
  75. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.js +2 -2
  76. package/dist/cjs/hooks/useLastChanged/useLastChanged.js +2 -2
  77. package/dist/cjs/hooks/useLatest/useLatest.js +1 -1
  78. package/dist/cjs/hooks/useLess/useLess.js +1 -1
  79. package/dist/cjs/hooks/useList/useList.js +2 -2
  80. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.js +2 -2
  81. package/dist/cjs/hooks/useLocalStorage/useLocalStorage.js.map +1 -1
  82. package/dist/cjs/hooks/useLogger/useLogger.js +2 -2
  83. package/dist/cjs/hooks/useLongPress/useLongPress.js +2 -2
  84. package/dist/cjs/hooks/useMap/useMap.js +2 -2
  85. package/dist/cjs/hooks/useMeasure/useMeasure.js +2 -2
  86. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.js +1 -1
  87. package/dist/cjs/hooks/useMediaQuery/useMediaQuery.js.map +1 -1
  88. package/dist/cjs/hooks/useMemory/useMemory.js +2 -2
  89. package/dist/cjs/hooks/useMemory/useMemory.js.map +1 -1
  90. package/dist/cjs/hooks/useMount/useMount.js +1 -1
  91. package/dist/cjs/hooks/useMouse/useMouse.js +2 -2
  92. package/dist/cjs/hooks/useMutation/useMutation.js +2 -2
  93. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.js +2 -2
  94. package/dist/cjs/hooks/useNetwork/useNetwork.js +2 -2
  95. package/dist/cjs/hooks/useNetwork/useNetwork.js.map +1 -1
  96. package/dist/cjs/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  97. package/dist/cjs/hooks/useOnline/useOnline.js +1 -1
  98. package/dist/cjs/hooks/useOnline/useOnline.js.map +1 -1
  99. package/dist/cjs/hooks/useOperatingSystem/useOperatingSystem.js +2 -2
  100. package/dist/cjs/hooks/useOptimistic/useOptimistic.js +2 -2
  101. package/dist/cjs/hooks/useOrientation/useOrientation.js +2 -2
  102. package/dist/cjs/hooks/useOrientation/useOrientation.js.map +1 -1
  103. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js +2 -2
  104. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  105. package/dist/cjs/hooks/usePageLeave/usePageLeave.js +2 -2
  106. package/dist/cjs/hooks/usePaint/usePaint.js +2 -2
  107. package/dist/cjs/hooks/useParallax/useParallax.js +2 -2
  108. package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.js +2 -2
  109. package/dist/cjs/hooks/usePerformanceObserver/usePerformanceObserver.js.map +1 -1
  110. package/dist/cjs/hooks/usePermission/usePermission.js +2 -2
  111. package/dist/cjs/hooks/usePermission/usePermission.js.map +1 -1
  112. package/dist/cjs/hooks/usePointerLock/usePointerLock.js +2 -2
  113. package/dist/cjs/hooks/usePointerLock/usePointerLock.js.map +1 -1
  114. package/dist/cjs/hooks/usePostMessage/usePostMessage.js +1 -1
  115. package/dist/cjs/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  116. package/dist/cjs/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  117. package/dist/cjs/hooks/usePreferredDark/usePreferredDark.js +1 -1
  118. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  119. package/dist/cjs/hooks/usePreferredLanguages/usePreferredLanguages.js.map +1 -1
  120. package/dist/cjs/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  121. package/dist/cjs/hooks/usePrevious/usePrevious.js +1 -1
  122. package/dist/cjs/hooks/useQuery/useQuery.js +2 -2
  123. package/dist/cjs/hooks/useQueue/useQueue.js +2 -2
  124. package/dist/cjs/hooks/useRaf/useRaf.js +2 -2
  125. package/dist/cjs/hooks/useRaf/useRaf.js.map +1 -1
  126. package/dist/cjs/hooks/useRafValue/useRafValue.js +2 -2
  127. package/dist/cjs/hooks/useRefState/useRefState.js +2 -2
  128. package/dist/cjs/hooks/useRefState/useRefState.js.map +1 -1
  129. package/dist/cjs/hooks/useRenderCount/useRenderCount.js +1 -1
  130. package/dist/cjs/hooks/useRenderInfo/useRenderInfo.js +1 -1
  131. package/dist/cjs/hooks/useRerender/useRerender.js +1 -1
  132. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js +2 -2
  133. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  134. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js +2 -2
  135. package/dist/cjs/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -1
  136. package/dist/cjs/hooks/useScript/useScript.js +2 -2
  137. package/dist/cjs/hooks/useScroll/useScroll.js +2 -2
  138. package/dist/cjs/hooks/useScroll/useScroll.js.map +1 -1
  139. package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.js +2 -2
  140. package/dist/cjs/hooks/useScrollTo/useScrollTo.js +2 -2
  141. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.js +2 -2
  142. package/dist/cjs/hooks/useSessionStorage/useSessionStorage.js.map +1 -1
  143. package/dist/cjs/hooks/useSet/useSet.js +2 -2
  144. package/dist/cjs/hooks/useShare/useShare.js +2 -2
  145. package/dist/cjs/hooks/useStateHistory/useStateHistory.js +2 -2
  146. package/dist/cjs/hooks/useStep/useStep.js +2 -2
  147. package/dist/cjs/hooks/useStopwatch/useStopwatch.js +2 -2
  148. package/dist/cjs/hooks/useStorage/useStorage.js +2 -2
  149. package/dist/cjs/hooks/useStorage/useStorage.js.map +1 -1
  150. package/dist/cjs/hooks/useTextDirection/useTextDirection.js +2 -2
  151. package/dist/cjs/hooks/useTextSelection/useTextSelection.js +2 -2
  152. package/dist/cjs/hooks/useTextSelection/useTextSelection.js.map +1 -1
  153. package/dist/cjs/hooks/useThrottleCallback/useThrottleCallback.js +1 -1
  154. package/dist/cjs/hooks/useThrottleCallback/useThrottleCallback.js.map +1 -1
  155. package/dist/cjs/hooks/useThrottleValue/useThrottleValue.js +2 -2
  156. package/dist/cjs/hooks/useThrottleValue/useThrottleValue.js.map +1 -1
  157. package/dist/cjs/hooks/useTime/useTime.js +2 -2
  158. package/dist/cjs/hooks/useTimeout/useTimeout.js +2 -2
  159. package/dist/cjs/hooks/useTimer/useTimer.js +2 -2
  160. package/dist/cjs/hooks/useTimer/useTimer.js.map +1 -1
  161. package/dist/cjs/hooks/useToggle/useToggle.js +2 -2
  162. package/dist/cjs/hooks/useUnmount/useUnmount.js +1 -1
  163. package/dist/cjs/hooks/useVibrate/useVibrate.js +2 -2
  164. package/dist/cjs/hooks/useVibrate/useVibrate.js.map +1 -1
  165. package/dist/cjs/hooks/useWebSocket/useWebSocket.js +2 -2
  166. package/dist/cjs/hooks/useWebSocket/useWebSocket.js.map +1 -1
  167. package/dist/cjs/hooks/useWindowEvent/useWindowEvent.js +2 -2
  168. package/dist/cjs/hooks/useWindowFocus/useWindowFocus.js +2 -2
  169. package/dist/cjs/hooks/useWindowScroll/useWindowScroll.js +2 -2
  170. package/dist/cjs/hooks/useWindowSize/useWindowSize.js +2 -2
  171. package/dist/cjs/hooks/useWizard/useWizard.js +2 -2
  172. package/dist/cjs/index.js +2 -2
  173. package/dist/cjs/utils/helpers/debounce.js +1 -1
  174. package/dist/cjs/utils/helpers/getDate.js +1 -1
  175. package/dist/cjs/utils/helpers/getElement.js +1 -1
  176. package/dist/cjs/utils/helpers/getRetry.js +1 -1
  177. package/dist/cjs/utils/helpers/index.js +2 -2
  178. package/dist/cjs/utils/helpers/isTarget.js +2 -2
  179. package/dist/cjs/utils/helpers/throttle.js +1 -1
  180. package/dist/esm/{_rollupPluginBabelHelpers-D_XDB4a1.js → _rollupPluginBabelHelpers-C8LJM1Lv.js} +2 -2
  181. package/dist/esm/_rollupPluginBabelHelpers-C8LJM1Lv.js.map +1 -0
  182. package/dist/esm/hooks/index.js +2 -2
  183. package/dist/esm/hooks/useActiveElement/useActiveElement.js +2 -2
  184. package/dist/esm/hooks/useAsync/useAsync.js +2 -2
  185. package/dist/esm/hooks/useBattery/useBattery.js +2 -2
  186. package/dist/esm/hooks/useBattery/useBattery.js.map +1 -1
  187. package/dist/esm/hooks/useBluetooth/useBluetooth.js +2 -2
  188. package/dist/esm/hooks/useBluetooth/useBluetooth.js.map +1 -1
  189. package/dist/esm/hooks/useBoolean/useBoolean.js +2 -2
  190. package/dist/esm/hooks/useBoolean/useBoolean.js.map +1 -1
  191. package/dist/esm/hooks/useBreakpoints/useBreakpoints.js +2 -2
  192. package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.js +1 -1
  193. package/dist/esm/hooks/useBrowserLanguage/useBrowserLanguage.js.map +1 -1
  194. package/dist/esm/hooks/useClickOutside/useClickOutside.js +2 -2
  195. package/dist/esm/hooks/useClipboard/useClipboard.js +2 -2
  196. package/dist/esm/hooks/useClipboard/useClipboard.js.map +1 -1
  197. package/dist/esm/hooks/useConst/useConst.js +1 -1
  198. package/dist/esm/hooks/useCookie/useCookie.js +2 -2
  199. package/dist/esm/hooks/useCookie/useCookie.js.map +1 -1
  200. package/dist/esm/hooks/useCookies/useCookies.js +2 -2
  201. package/dist/esm/hooks/useCounter/useCounter.js +2 -2
  202. package/dist/esm/hooks/useCounter/useCounter.js.map +1 -1
  203. package/dist/esm/hooks/useCssVar/useCssVar.js +2 -2
  204. package/dist/esm/hooks/useCssVar/useCssVar.js.map +1 -1
  205. package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.js +1 -1
  206. package/dist/esm/hooks/useDebounceCallback/useDebounceCallback.js.map +1 -1
  207. package/dist/esm/hooks/useDebounceValue/useDebounceValue.js +2 -2
  208. package/dist/esm/hooks/useDebounceValue/useDebounceValue.js.map +1 -1
  209. package/dist/esm/hooks/useDefault/useDefault.js +2 -2
  210. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js +2 -2
  211. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.js.map +1 -1
  212. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js +2 -2
  213. package/dist/esm/hooks/useDeviceOrientation/useDeviceOrientation.js.map +1 -1
  214. package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.js +2 -2
  215. package/dist/esm/hooks/useDevicePixelRatio/useDevicePixelRatio.js.map +1 -1
  216. package/dist/esm/hooks/useDidUpdate/useDidUpdate.js +1 -1
  217. package/dist/esm/hooks/useDidUpdate/useDidUpdate.js.map +1 -1
  218. package/dist/esm/hooks/useDisclosure/useDisclosure.js +2 -2
  219. package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.js +2 -2
  220. package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.js.map +1 -1
  221. package/dist/esm/hooks/useDocumentEvent/useDocumentEvent.js +2 -2
  222. package/dist/esm/hooks/useDocumentTitle/useDocumentTitle.js +2 -2
  223. package/dist/esm/hooks/useDocumentVisibility/useDocumentVisibility.js +1 -1
  224. package/dist/esm/hooks/useElementSize/useElementSize.js +2 -2
  225. package/dist/esm/hooks/useEvent/useEvent.js +1 -1
  226. package/dist/esm/hooks/useEventListener/useEventListener.js +2 -2
  227. package/dist/esm/hooks/useEyeDropper/useEyeDropper.js +2 -2
  228. package/dist/esm/hooks/useEyeDropper/useEyeDropper.js.map +1 -1
  229. package/dist/esm/hooks/useFavicon/useFavicon.js +2 -2
  230. package/dist/esm/hooks/useField/useField.js +2 -2
  231. package/dist/esm/hooks/useFileDialog/useFileDialog.js +2 -2
  232. package/dist/esm/hooks/useFocus/useFocus.js +2 -2
  233. package/dist/esm/hooks/useFps/useFps.js +2 -2
  234. package/dist/esm/hooks/useFps/useFps.js.map +1 -1
  235. package/dist/esm/hooks/useFullscreen/useFullscreen.js +2 -2
  236. package/dist/esm/hooks/useGamepad/useGamepad.js +2 -2
  237. package/dist/esm/hooks/useGamepad/useGamepad.js.map +1 -1
  238. package/dist/esm/hooks/useGeolocation/useGeolocation.js +2 -2
  239. package/dist/esm/hooks/useGeolocation/useGeolocation.js.map +1 -1
  240. package/dist/esm/hooks/useHash/useHash.js +2 -2
  241. package/dist/esm/hooks/useHotkeys/useHotkeys.js +2 -2
  242. package/dist/esm/hooks/useHover/useHover.js +2 -2
  243. package/dist/esm/hooks/useIdle/useIdle.js +2 -2
  244. package/dist/esm/hooks/useImage/useImage.js +2 -2
  245. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.js +2 -2
  246. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.js +2 -2
  247. package/dist/esm/hooks/useInterval/useInterval.js +2 -2
  248. package/dist/esm/hooks/useInterval/useInterval.js.map +1 -1
  249. package/dist/esm/hooks/useIsFirstRender/useIsFirstRender.js +1 -1
  250. package/dist/esm/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +1 -1
  251. package/dist/esm/hooks/useKeyPress/useKeyPress.js +2 -2
  252. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.js +2 -2
  253. package/dist/esm/hooks/useKeyboard/useKeyboard.js +2 -2
  254. package/dist/esm/hooks/useKeysPressed/useKeysPressed.js +2 -2
  255. package/dist/esm/hooks/useLastChanged/useLastChanged.js +2 -2
  256. package/dist/esm/hooks/useLatest/useLatest.js +1 -1
  257. package/dist/esm/hooks/useLess/useLess.js +1 -1
  258. package/dist/esm/hooks/useList/useList.js +2 -2
  259. package/dist/esm/hooks/useLocalStorage/useLocalStorage.js +2 -2
  260. package/dist/esm/hooks/useLocalStorage/useLocalStorage.js.map +1 -1
  261. package/dist/esm/hooks/useLogger/useLogger.js +2 -2
  262. package/dist/esm/hooks/useLongPress/useLongPress.js +2 -2
  263. package/dist/esm/hooks/useMap/useMap.js +2 -2
  264. package/dist/esm/hooks/useMeasure/useMeasure.js +2 -2
  265. package/dist/esm/hooks/useMediaQuery/useMediaQuery.js +1 -1
  266. package/dist/esm/hooks/useMediaQuery/useMediaQuery.js.map +1 -1
  267. package/dist/esm/hooks/useMemory/useMemory.js +2 -2
  268. package/dist/esm/hooks/useMemory/useMemory.js.map +1 -1
  269. package/dist/esm/hooks/useMount/useMount.js +1 -1
  270. package/dist/esm/hooks/useMouse/useMouse.js +2 -2
  271. package/dist/esm/hooks/useMutation/useMutation.js +2 -2
  272. package/dist/esm/hooks/useMutationObserver/useMutationObserver.js +2 -2
  273. package/dist/esm/hooks/useNetwork/useNetwork.js +2 -2
  274. package/dist/esm/hooks/useNetwork/useNetwork.js.map +1 -1
  275. package/dist/esm/hooks/useOffsetPagination/useOffsetPagination.js +2 -2
  276. package/dist/esm/hooks/useOnline/useOnline.js +1 -1
  277. package/dist/esm/hooks/useOnline/useOnline.js.map +1 -1
  278. package/dist/esm/hooks/useOperatingSystem/useOperatingSystem.js +2 -2
  279. package/dist/esm/hooks/useOptimistic/useOptimistic.js +2 -2
  280. package/dist/esm/hooks/useOrientation/useOrientation.js +2 -2
  281. package/dist/esm/hooks/useOrientation/useOrientation.js.map +1 -1
  282. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js +2 -2
  283. package/dist/esm/hooks/useOtpCredential/useOtpCredential.js.map +1 -1
  284. package/dist/esm/hooks/usePageLeave/usePageLeave.js +2 -2
  285. package/dist/esm/hooks/usePaint/usePaint.js +2 -2
  286. package/dist/esm/hooks/useParallax/useParallax.js +2 -2
  287. package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.js +2 -2
  288. package/dist/esm/hooks/usePerformanceObserver/usePerformanceObserver.js.map +1 -1
  289. package/dist/esm/hooks/usePermission/usePermission.js +2 -2
  290. package/dist/esm/hooks/usePermission/usePermission.js.map +1 -1
  291. package/dist/esm/hooks/usePointerLock/usePointerLock.js +2 -2
  292. package/dist/esm/hooks/usePointerLock/usePointerLock.js.map +1 -1
  293. package/dist/esm/hooks/usePostMessage/usePostMessage.js +1 -1
  294. package/dist/esm/hooks/usePreferredColorScheme/usePreferredColorScheme.js +1 -1
  295. package/dist/esm/hooks/usePreferredContrast/usePreferredContrast.js +1 -1
  296. package/dist/esm/hooks/usePreferredDark/usePreferredDark.js +1 -1
  297. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.js +1 -1
  298. package/dist/esm/hooks/usePreferredLanguages/usePreferredLanguages.js.map +1 -1
  299. package/dist/esm/hooks/usePreferredReducedMotion/usePreferredReducedMotion.js +1 -1
  300. package/dist/esm/hooks/usePrevious/usePrevious.js +1 -1
  301. package/dist/esm/hooks/useQuery/useQuery.js +2 -2
  302. package/dist/esm/hooks/useQueue/useQueue.js +2 -2
  303. package/dist/esm/hooks/useRaf/useRaf.js +2 -2
  304. package/dist/esm/hooks/useRaf/useRaf.js.map +1 -1
  305. package/dist/esm/hooks/useRafValue/useRafValue.js +2 -2
  306. package/dist/esm/hooks/useRefState/useRefState.js +2 -2
  307. package/dist/esm/hooks/useRefState/useRefState.js.map +1 -1
  308. package/dist/esm/hooks/useRenderCount/useRenderCount.js +1 -1
  309. package/dist/esm/hooks/useRenderInfo/useRenderInfo.js +1 -1
  310. package/dist/esm/hooks/useRerender/useRerender.js +1 -1
  311. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js +2 -2
  312. package/dist/esm/hooks/useResizeObserver/useResizeObserver.js.map +1 -1
  313. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js +2 -2
  314. package/dist/esm/hooks/useScreenOrientation/useScreenOrientation.js.map +1 -1
  315. package/dist/esm/hooks/useScript/useScript.js +2 -2
  316. package/dist/esm/hooks/useScroll/useScroll.js +2 -2
  317. package/dist/esm/hooks/useScroll/useScroll.js.map +1 -1
  318. package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.js +2 -2
  319. package/dist/esm/hooks/useScrollTo/useScrollTo.js +2 -2
  320. package/dist/esm/hooks/useSessionStorage/useSessionStorage.js +2 -2
  321. package/dist/esm/hooks/useSessionStorage/useSessionStorage.js.map +1 -1
  322. package/dist/esm/hooks/useSet/useSet.js +2 -2
  323. package/dist/esm/hooks/useShare/useShare.js +2 -2
  324. package/dist/esm/hooks/useStateHistory/useStateHistory.js +2 -2
  325. package/dist/esm/hooks/useStep/useStep.js +2 -2
  326. package/dist/esm/hooks/useStopwatch/useStopwatch.js +2 -2
  327. package/dist/esm/hooks/useStorage/useStorage.js +2 -2
  328. package/dist/esm/hooks/useStorage/useStorage.js.map +1 -1
  329. package/dist/esm/hooks/useTextDirection/useTextDirection.js +2 -2
  330. package/dist/esm/hooks/useTextSelection/useTextSelection.js +2 -2
  331. package/dist/esm/hooks/useTextSelection/useTextSelection.js.map +1 -1
  332. package/dist/esm/hooks/useThrottleCallback/useThrottleCallback.js +1 -1
  333. package/dist/esm/hooks/useThrottleCallback/useThrottleCallback.js.map +1 -1
  334. package/dist/esm/hooks/useThrottleValue/useThrottleValue.js +2 -2
  335. package/dist/esm/hooks/useThrottleValue/useThrottleValue.js.map +1 -1
  336. package/dist/esm/hooks/useTime/useTime.js +2 -2
  337. package/dist/esm/hooks/useTimeout/useTimeout.js +2 -2
  338. package/dist/esm/hooks/useTimer/useTimer.js +2 -2
  339. package/dist/esm/hooks/useTimer/useTimer.js.map +1 -1
  340. package/dist/esm/hooks/useToggle/useToggle.js +2 -2
  341. package/dist/esm/hooks/useUnmount/useUnmount.js +1 -1
  342. package/dist/esm/hooks/useVibrate/useVibrate.js +2 -2
  343. package/dist/esm/hooks/useVibrate/useVibrate.js.map +1 -1
  344. package/dist/esm/hooks/useWebSocket/useWebSocket.js +2 -2
  345. package/dist/esm/hooks/useWebSocket/useWebSocket.js.map +1 -1
  346. package/dist/esm/hooks/useWindowEvent/useWindowEvent.js +2 -2
  347. package/dist/esm/hooks/useWindowFocus/useWindowFocus.js +2 -2
  348. package/dist/esm/hooks/useWindowScroll/useWindowScroll.js +2 -2
  349. package/dist/esm/hooks/useWindowSize/useWindowSize.js +2 -2
  350. package/dist/esm/hooks/useWizard/useWizard.js +2 -2
  351. package/dist/esm/index.js +2 -2
  352. package/dist/esm/utils/helpers/debounce.js +1 -1
  353. package/dist/esm/utils/helpers/getDate.js +1 -1
  354. package/dist/esm/utils/helpers/getElement.js +1 -1
  355. package/dist/esm/utils/helpers/getRetry.js +1 -1
  356. package/dist/esm/utils/helpers/index.js +2 -2
  357. package/dist/esm/utils/helpers/isTarget.js +2 -2
  358. package/dist/esm/utils/helpers/throttle.js +1 -1
  359. package/dist/types/index.d.ts +131 -60
  360. package/package.json +1 -1
  361. package/dist/cjs/_rollupPluginBabelHelpers-C-GU1yny.js.map +0 -1
  362. package/dist/cjs/hooks/useGamepad/helpers/index.js +0 -3
  363. package/dist/cjs/hooks/useGamepad/helpers/index.js.map +0 -1
  364. package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +0 -3
  365. package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js.map +0 -1
  366. package/dist/esm/_rollupPluginBabelHelpers-D_XDB4a1.js.map +0 -1
  367. package/dist/esm/hooks/useGamepad/helpers/index.js +0 -3
  368. package/dist/esm/hooks/useGamepad/helpers/index.js.map +0 -1
  369. package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js +0 -3
  370. package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js.map +0 -1
@@ -69,6 +69,8 @@ interface UseBatteryStateReturn {
69
69
  * @description - Hook for getting information about battery status
70
70
  * @category Browser
71
71
  *
72
+ * @browserapi navigator.getBattery https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getBattery
73
+ *
72
74
  * @returns {UseBatteryStateReturn} Object containing battery information & Battery API support
73
75
  *
74
76
  * @example
@@ -103,6 +105,8 @@ interface UseBluetoothOptions {
103
105
  * @description - Hook for getting information about bluetooth
104
106
  * @category Browser
105
107
  *
108
+ * @browserapi navigator.bluetooth https://developer.mozilla.org/en-US/docs/Web/API/Navigator/bluetooth
109
+ *
106
110
  * @param {boolean} [options.acceptAllDevices=false] The options to request all Bluetooth devices
107
111
  * @param {Array<BluetoothLEScanFilter>} [options.filters] Array of filters to apply when scanning Bluetooth devices
108
112
  * @param {Array<BluetoothServiceUUID>} [options.optionalServices] Array of optional services that the application can use
@@ -122,7 +126,7 @@ type UseBooleanReturn = [
122
126
  ];
123
127
  /**
124
128
  * @name useBoolean
125
- * @description - Hook provides a boolean state and a function to toggle the boolean value
129
+ * @description - Hook provides opportunity to manage boolean state
126
130
  * @category Utilities
127
131
  *
128
132
  * @param {boolean} [initialValue=false] The initial boolean value
@@ -264,6 +268,8 @@ declare const BREAKPOINTS_PRIME_FLEX: {
264
268
  * @description - Hook that returns the current browser language
265
269
  * @category Browser
266
270
  *
271
+ * @browserapi navigator.language https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language
272
+ *
267
273
  * @returns {string} The current browser language
268
274
  *
269
275
  * @example
@@ -279,7 +285,7 @@ interface StateRef<Value> {
279
285
  /**
280
286
  * @name useRefState
281
287
  * @description - Hook that returns the state reference of the value
282
- * @category Lifecycle
288
+ * @category Utilities
283
289
  *
284
290
  * @template Value The type of the value
285
291
  * @param {Value} [initialValue] The initial value
@@ -341,6 +347,8 @@ interface UseCopyToClipboardParams {
341
347
  * @description - Hook that manages a copy to clipboard
342
348
  * @category Browser
343
349
  *
350
+ * @browserapi navigator.clipboard https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clipboard
351
+ *
344
352
  * @param {boolean} [params.enabled=false] Whether the copy to clipboard is enabled
345
353
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
346
354
  *
@@ -481,7 +489,7 @@ interface UseCounter {
481
489
  }
482
490
  /**
483
491
  * @name useCounter
484
- * @description - Hook that manages a counter with increment, decrement, reset, and set functionalities
492
+ * @description - Hook that manages a counter
485
493
  * @category Utilities
486
494
  *
487
495
  * @overload
@@ -519,7 +527,7 @@ interface UseCssVar {
519
527
  }
520
528
  /**
521
529
  * @name useCssVar
522
- * @description - Hook that returns the value of a CSS variable
530
+ * @description - Hook that returns the value of a css variable
523
531
  * @category Utilities
524
532
  *
525
533
  * @overload
@@ -544,7 +552,7 @@ declare const useCssVar: UseCssVar;
544
552
 
545
553
  /**
546
554
  * @name useDebounceCallback
547
- * @description - Hook that creates a debounced callback and returns a stable reference of it
555
+ * @description - Hook that creates a debounced callback
548
556
  * @category Utilities
549
557
  *
550
558
  * @template Params The type of the params
@@ -560,7 +568,7 @@ declare const useDebounceCallback: <Params extends unknown[], Return>(callback:
560
568
 
561
569
  /**
562
570
  * @name useDebounceValue
563
- * @description - Hook that creates a debounced value and returns a stable reference of it
571
+ * @description - Hook that creates a debounced value
564
572
  * @category Utilities
565
573
  *
566
574
  * @template Value The type of the value
@@ -607,6 +615,8 @@ interface UseDeviceMotionParams {
607
615
  * @description - Hook that work with device motion
608
616
  * @category Utilities
609
617
  *
618
+ * @browserapi DeviceMotionEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceMotionEvent
619
+ *
610
620
  * @param {number} [delay=1000] The delay in milliseconds
611
621
  * @param {(event: DeviceMotionEvent) => void} [callback] The callback function to be invoked
612
622
  * @param {boolean} [enabled=true] Whether to enable the hook
@@ -638,6 +648,8 @@ interface UseDeviceOrientationReturn {
638
648
  * @description - Hook that provides the current device orientation
639
649
  * @category Sensors
640
650
  *
651
+ * @browserapi DeviceOrientationEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceOrientationEvent
652
+ *
641
653
  * @returns {UseDeviceOrientationReturn} The current device orientation
642
654
  *
643
655
  * @example
@@ -654,9 +666,11 @@ interface UseDevicePixelRatioReturn {
654
666
  }
655
667
  /**
656
668
  * @name useDevicePixelRatio
657
- * @description - Hook that returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device
669
+ * @description - Hook that returns the device's pixel ratio
658
670
  * @category Utilities
659
671
  *
672
+ * @browserapi window.devicePixelRatio https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
673
+ *
660
674
  * @returns {UseDevicePixelRatioReturn} The ratio and supported flag
661
675
  *
662
676
  * @example
@@ -666,14 +680,14 @@ declare const useDevicePixelRatio: () => UseDevicePixelRatioReturn;
666
680
 
667
681
  /**
668
682
  * @name useDidUpdate
669
- * @description – Hook that behaves like useEffect, but skips the effect on the initial render
683
+ * @description – Hook that triggers the effect callback on updates
670
684
  * @category Lifecycle
671
685
  *
672
686
  * @param {EffectCallback} effect The effect callback
673
687
  * @param {DependencyList} [deps] The dependencies list for the effect
674
688
  *
675
689
  * @example
676
- * useDidUpdate(() => console.log('Won't be called when mounted'), [deps]);
690
+ * useDidUpdate(() => console.log("Won't be called when mounted"), [deps]);
677
691
  */
678
692
  declare const useDidUpdate: (effect: EffectCallback, deps?: DependencyList) => void;
679
693
 
@@ -742,9 +756,11 @@ interface UseDisplayMediaOverload {
742
756
  }
743
757
  /**
744
758
  * @name useDisplayMedia
745
- * @description - Hook that provides screen sharing functionality using the Display Media API
759
+ * @description - Hook that provides screen sharing functionality
746
760
  * @category Browser
747
761
  *
762
+ * @browserapi mediaDevices.getDisplayMedia https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia
763
+ *
748
764
  * @overload
749
765
  * @template Target The target video element
750
766
  * @param {Target} target The target video element to display the media stream
@@ -973,6 +989,8 @@ interface UseEyeDropperReturn {
973
989
  * @description - Hook that gives you access to the eye dropper
974
990
  * @category Browser
975
991
  *
992
+ * @browserapi EyeDropper https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper
993
+ *
976
994
  * @param {string} [initialValue=undefined] The initial value for the eye dropper
977
995
  * @returns {UseEyeDropperReturn} An object containing the supported status, the value and the open method
978
996
  *
@@ -1191,6 +1209,8 @@ declare const useFocus: UseFocus;
1191
1209
  * @description - Hook that measures frames per second
1192
1210
  * @category Sensors
1193
1211
  *
1212
+ * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
1213
+ *
1194
1214
  * @returns {number} A number which determines frames per second
1195
1215
  *
1196
1216
  * @example
@@ -1254,6 +1274,37 @@ interface UseFullScreen {
1254
1274
  */
1255
1275
  declare const useFullscreen: UseFullScreen;
1256
1276
 
1277
+ declare global {
1278
+ interface Gamepad {
1279
+ hapticActuators?: GamepadHapticActuator[];
1280
+ }
1281
+ }
1282
+ /** The use gamepad return type */
1283
+ interface UseGamepadStateReturn {
1284
+ /** The gamepad active status */
1285
+ active: boolean;
1286
+ /** The gamepad state */
1287
+ gamepads: Gamepad[];
1288
+ /** The gamepad supported status */
1289
+ supported: boolean;
1290
+ }
1291
+ /**
1292
+ * @name useGamepad
1293
+ * @description - Hook for getting information about gamepad
1294
+ * @category Browser
1295
+ *
1296
+ * @browserapi navigator.getGamepads https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getGamepads
1297
+ *
1298
+ * @returns {UseGamepadStateReturn} An object containing the gamepad information
1299
+ *
1300
+ * @example
1301
+ * const { supported, gamepads, active } = useGamepad();
1302
+ */
1303
+ declare const useGamepad: () => {
1304
+ active: boolean;
1305
+ supported: boolean;
1306
+ gamepads: Gamepad[];
1307
+ };
1257
1308
  declare const mapGamepadToXbox360Controller: (gamepad: Gamepad) => {
1258
1309
  buttons: {
1259
1310
  a: GamepadButton;
@@ -1291,36 +1342,6 @@ declare const mapGamepadToXbox360Controller: (gamepad: Gamepad) => {
1291
1342
  start: GamepadButton;
1292
1343
  };
1293
1344
 
1294
- declare global {
1295
- interface Gamepad {
1296
- hapticActuators?: GamepadHapticActuator[];
1297
- }
1298
- }
1299
- /** The use gamepad return type */
1300
- interface UseGamepadStateReturn {
1301
- /** The gamepad active status */
1302
- active: boolean;
1303
- /** The gamepad state */
1304
- gamepads: Gamepad[];
1305
- /** The gamepad supported status */
1306
- supported: boolean;
1307
- }
1308
- /**
1309
- * @name useGamepad
1310
- * @description - Hook for getting information about gamepad
1311
- * @category Browser
1312
- *
1313
- * @returns {UseGamepadStateReturn} An object containing the gamepad information
1314
- *
1315
- * @example
1316
- * const { supported, gamepads, active } = useGamepad();
1317
- */
1318
- declare const useGamepad: () => {
1319
- active: boolean;
1320
- supported: boolean;
1321
- gamepads: Gamepad[];
1322
- };
1323
-
1324
1345
  /** The use geolocation return type */
1325
1346
  interface UseGeolocationReturn {
1326
1347
  /** The accuracy of the last position update */
@@ -1351,6 +1372,8 @@ type UseGeolocationParams = PositionOptions;
1351
1372
  * @description - Hook that returns the current geolocation
1352
1373
  * @category Browser
1353
1374
  *
1375
+ * @browserapi navigator.geolocation https://developer.mozilla.org/en-US/docs/Web/API/Navigator/geolocation
1376
+ *
1354
1377
  * @param {boolean} [params.enableHighAccuracy] Enable high accuracy
1355
1378
  * @param {number} [params.maximumAge] Maximum age
1356
1379
  * @param {number} [params.timeout] Timeout
@@ -1708,7 +1731,7 @@ declare const useIntersectionObserver: UseIntersectionObserver;
1708
1731
  /** The use interval options */
1709
1732
  interface UseIntervalOptions {
1710
1733
  /** Start the interval immediately */
1711
- enabled?: boolean;
1734
+ immediately?: boolean;
1712
1735
  }
1713
1736
  /** The use interval return type */
1714
1737
  interface UseIntervalReturn {
@@ -1718,6 +1741,8 @@ interface UseIntervalReturn {
1718
1741
  pause: () => void;
1719
1742
  /** Resume the interval */
1720
1743
  resume: () => void;
1744
+ /** Toggle the interval */
1745
+ toggle: () => void;
1721
1746
  }
1722
1747
  interface UseInterval {
1723
1748
  (callback: () => void, interval?: number, options?: UseIntervalOptions): UseIntervalReturn;
@@ -1733,19 +1758,19 @@ interface UseInterval {
1733
1758
  * @overload
1734
1759
  * @param {() => void} callback Any callback function
1735
1760
  * @param {number} [interval=1000] Time in milliseconds
1736
- * @param {boolean} [options.enabled=true] Start the interval immediately
1761
+ * @param {boolean} [options.immediately=true] Start the interval immediately
1737
1762
  * @returns {UseIntervalReturn}
1738
1763
  *
1739
1764
  * @example
1740
- * const { active, pause, resume } = useInterval(() => console.log('inside interval'), 2500);
1765
+ * const { active, pause, resume, toggle } = useInterval(() => console.log('inside interval'), 2500);
1741
1766
  *
1742
1767
  * @overload
1743
1768
  * @param {() => void} callback Any callback function
1744
1769
  * @param {number} [options.interval=1000] Time in milliseconds
1745
- * @param {boolean} [options.enabled=true] Start the interval immediately
1770
+ * @param {boolean} [options.immediately=true] Start the interval immediately
1746
1771
  *
1747
1772
  * @example
1748
- * const { active, pause, resume } = useInterval(() => console.log('inside interval'), { interval: 2500 });
1773
+ * const { active, pause, resume, toggle } = useInterval(() => console.log('inside interval'), { interval: 2500 });
1749
1774
  */
1750
1775
  declare const useInterval: UseInterval;
1751
1776
 
@@ -2026,6 +2051,8 @@ declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<V
2026
2051
  * @description - Hook that manages local storage value
2027
2052
  * @category Browser
2028
2053
  *
2054
+ * @browserapi localStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
2055
+ *
2029
2056
  * @template Value The type of the value
2030
2057
  * @param {string} key The key of the storage
2031
2058
  * @param {UseStorageInitialValue<Value>} [initialValue] The initial value of the storage
@@ -2159,6 +2186,8 @@ declare const useMeasure: UseMeasureScreen;
2159
2186
  * @description - Hook that manages a media query
2160
2187
  * @category Browser
2161
2188
  *
2189
+ * @browserapi window.matchMedia https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia
2190
+ *
2162
2191
  * @param {string} query The media query string
2163
2192
  * @returns {boolean} A boolean indicating if the media query matches
2164
2193
  *
@@ -2188,6 +2217,8 @@ interface UseMemoryReturn {
2188
2217
  * @description - Hook that gives you current memory usage
2189
2218
  * @category Browser
2190
2219
  *
2220
+ * @browserapi performance.memory https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
2221
+ *
2191
2222
  * @returns {UseMemoryReturn} An object containing the current memory usage
2192
2223
  *
2193
2224
  * @example
@@ -2393,6 +2424,8 @@ declare const getConnection: () => Connection;
2393
2424
  * @description - Hook to track network status
2394
2425
  * @category Sensors
2395
2426
  *
2427
+ * @browserapi navigator.connection https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection
2428
+ *
2396
2429
  * @returns {UseNetworkReturn} An object containing the network status
2397
2430
  *
2398
2431
  * @example
@@ -2474,6 +2507,8 @@ declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange
2474
2507
  * @description - Hook that manages if the user is online
2475
2508
  * @category Sensors
2476
2509
  *
2510
+ * @browserapi navigator.onLine https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
2511
+ *
2477
2512
  * @returns {boolean} A boolean indicating if the user is online
2478
2513
  *
2479
2514
  * @example
@@ -2527,6 +2562,8 @@ interface UseOrientationReturn {
2527
2562
  * @description - Hook that returns the current screen orientation
2528
2563
  * @category Browser
2529
2564
  *
2565
+ * @browserapi window.screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
2566
+ *
2530
2567
  * @returns {UseOrientationReturn} An object containing the current screen orientation
2531
2568
  *
2532
2569
  * @example
@@ -2565,6 +2602,8 @@ interface UseOtpCredential {
2565
2602
  * @description - Hook that creates an otp credential
2566
2603
  * @category Browser
2567
2604
  *
2605
+ * @browserapi navigator.credentials https://developer.mozilla.org/en-US/docs/Web/API/Navigator/credentials
2606
+ *
2568
2607
  * @overload
2569
2608
  * @param {UseOtpCredentialCallback} callback The callback function to be invoked
2570
2609
  * @returns {UseOtpCredentialReturn}
@@ -2755,7 +2794,9 @@ type UsePerformanceObserverOptions = PerformanceObserverInit & {
2755
2794
  /**
2756
2795
  * @name usePerformanceObserver
2757
2796
  * @description - Hook that allows you to observe performance entries
2758
- * @category Sensor
2797
+ * @category Sensors
2798
+ *
2799
+ * @browserapi PerformanceObserver https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver
2759
2800
  *
2760
2801
  * @param {UsePerformanceObserverOptions} options The options for the performance observer
2761
2802
  * @param {PerformanceObserverCallback} callback The function to handle performance entries
@@ -2792,6 +2833,8 @@ interface UsePermissionReturn {
2792
2833
  * @description - Hook that gives you the state of permission
2793
2834
  * @category Browser
2794
2835
  *
2836
+ * @browserapi navigator.permissions https://developer.mozilla.org/en-US/docs/Web/API/Navigator/permissions
2837
+ *
2795
2838
  * @param {UsePermissionName} permissionDescriptorName - The permission name
2796
2839
  * @param {boolean} [options.enabled=true] - Whether the permission is enabled
2797
2840
  * @returns {UsePermissionReturn} An object containing the state and the supported status
@@ -2807,9 +2850,13 @@ declare const usePermission: (permissionDescriptorName: UsePermissionName, optio
2807
2850
 
2808
2851
  /** The use pointer lock return type */
2809
2852
  interface UsePointerLockReturn {
2853
+ /** The pointer lock element */
2810
2854
  element?: Element;
2855
+ /** Whether the pointer lock is supported */
2811
2856
  supported: boolean;
2857
+ /** Lock the pointer lock */
2812
2858
  lock: (event: MouseEvent$1) => void;
2859
+ /** Unlock the pointer lock */
2813
2860
  unlock: () => boolean;
2814
2861
  }
2815
2862
  /**
@@ -2817,6 +2864,8 @@ interface UsePointerLockReturn {
2817
2864
  * @description - Hook that provides reactive pointer lock
2818
2865
  * @category Sensors
2819
2866
  *
2867
+ * @browserapi pointerLockElement https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerLockElement
2868
+ *
2820
2869
  * @returns {UsePointerLockReturn} An object containing the pointer lock element and functions to interact with the pointer lock
2821
2870
  *
2822
2871
  * @example
@@ -2884,6 +2933,8 @@ declare const usePreferredDark: () => boolean;
2884
2933
  * @description Hook that returns a browser preferred languages from navigator
2885
2934
  * @category Browser
2886
2935
  *
2936
+ * @browserapi navigator.languages https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages
2937
+ *
2887
2938
  * @returns {readonly string[]} An array of strings representing the user's preferred languages
2888
2939
  *
2889
2940
  * @example
@@ -2980,6 +3031,8 @@ interface UseRafReturn {
2980
3031
  * @description - Hook that defines the logic for raf callback
2981
3032
  * @category Utilities
2982
3033
  *
3034
+ * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
3035
+ *
2983
3036
  * @param {UseRafCallback} callback The callback to execute
2984
3037
  * @param {number} [options.delay] The delay between each frame in milliseconds
2985
3038
  * @param {boolean} [options.enabled=true] Whether the callback should be enabled
@@ -3076,6 +3129,8 @@ interface UseResizeObserver {
3076
3129
  * @description - Hook that gives you resize observer state
3077
3130
  * @category Browser
3078
3131
  *
3132
+ * @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
3133
+ *
3079
3134
  * @overload
3080
3135
  * @template Target The target element
3081
3136
  * @param {boolean} [options.enabled=true] The IntersectionObserver options
@@ -3126,6 +3181,8 @@ interface useScreenOrientationReturn {
3126
3181
  * @description - Hook that provides the current screen orientation
3127
3182
  * @category Sensors
3128
3183
  *
3184
+ * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
3185
+ *
3129
3186
  * @returns {useScreenOrientationReturn} The current screen orientation
3130
3187
  *
3131
3188
  * @example
@@ -3195,8 +3252,14 @@ interface UseScrollCallbackParams {
3195
3252
  interface UseScroll {
3196
3253
  <Target extends UseScrollTarget>(target: Target, callback?: (params: UseScrollCallbackParams, event: Event) => void): boolean;
3197
3254
  <Target extends UseScrollTarget>(target: Target, options?: UseScrollOptions): boolean;
3198
- <Target extends UseScrollTarget>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): [StateRef<Target>, boolean];
3199
- <Target extends UseScrollTarget>(options?: UseScrollOptions, target?: never): [StateRef<Target>, boolean];
3255
+ <Target extends UseScrollTarget>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): {
3256
+ ref: StateRef<Target>;
3257
+ scrolling: boolean;
3258
+ };
3259
+ <Target extends UseScrollTarget>(options?: UseScrollOptions, target?: never): {
3260
+ ref: StateRef<Target>;
3261
+ scrolling: boolean;
3262
+ };
3200
3263
  }
3201
3264
  /**
3202
3265
  * @name useScroll
@@ -3238,7 +3301,7 @@ interface UseScroll {
3238
3301
  * @returns {[StateRef<Target>, boolean]} The state of scrolling
3239
3302
  *
3240
3303
  * @example
3241
- * const [ref, scrolling] = useScroll(options);
3304
+ * const { ref, scrolling } = useScroll(options);
3242
3305
  *
3243
3306
  * @overload
3244
3307
  * @template Target The target element
@@ -3247,7 +3310,7 @@ interface UseScroll {
3247
3310
  * @returns {[StateRef<Target>, boolean]} The state of scrolling
3248
3311
  *
3249
3312
  * @example
3250
- * const [ref, scrolling] = useScroll(() => console.log('callback'));
3313
+ * const { ref, scrolling } = useScroll(() => console.log('callback'));
3251
3314
  */
3252
3315
  declare const useScroll: UseScroll;
3253
3316
 
@@ -3362,6 +3425,8 @@ declare const useScrollTo: UseScrollTo;
3362
3425
  * @description - Hook that manages session storage value
3363
3426
  * @category Browser
3364
3427
  *
3428
+ * @browserapi sessionStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
3429
+ *
3365
3430
  * @template Value The type of the value
3366
3431
  * @param {string} key The key of the storage
3367
3432
  * @param {UseStorageInitialValue<Value>} [initialValue] The initial value of the storage
@@ -3651,6 +3716,8 @@ interface UseTextSelectionReturn {
3651
3716
  * @description - Hook that manages the text selection
3652
3717
  * @category Sensors
3653
3718
  *
3719
+ * @browserapi document.getSelection https://developer.mozilla.org/en-US/docs/Web/API/Document/getSelection
3720
+ *
3654
3721
  * @returns {UseTextSelectionReturn} An object containing the current text selection
3655
3722
  *
3656
3723
  * @example
@@ -3660,7 +3727,7 @@ declare const useTextSelection: () => UseTextSelectionReturn;
3660
3727
 
3661
3728
  /**
3662
3729
  * @name useThrottleCallback
3663
- * @description - Hook that creates a throttled callback and returns a stable reference of it
3730
+ * @description - Hook that creates a throttled callback
3664
3731
  * @category Utilities
3665
3732
  *
3666
3733
  * @template Params The type of the params
@@ -3676,7 +3743,7 @@ declare const useThrottleCallback: <Params extends unknown[], Return>(callback:
3676
3743
 
3677
3744
  /**
3678
3745
  * @name useThrottleValue
3679
- * @description - Hook that creates a throttled value and returns a stable reference of it
3746
+ * @description - Hook that creates a throttled value
3680
3747
  * @category Utilities
3681
3748
  *
3682
3749
  * @template Value The type of the value
@@ -3744,7 +3811,7 @@ declare const getTimeFromSeconds: (timestamp: number) => {
3744
3811
  /** The use timer options type */
3745
3812
  interface UseTimerOptions {
3746
3813
  /** Whether the timer should start automatically */
3747
- autostart?: boolean;
3814
+ immediately?: boolean;
3748
3815
  /** The function to be executed when the timer is expired */
3749
3816
  onExpire?: () => void;
3750
3817
  /** Callback function to be executed on each tick of the timer */
@@ -3752,20 +3819,22 @@ interface UseTimerOptions {
3752
3819
  }
3753
3820
  /** The use timer return type */
3754
3821
  interface UseTimerReturn {
3822
+ /** flag to indicate if timer is active or not */
3823
+ active: boolean;
3755
3824
  /** The day count of the timer */
3756
3825
  days: number;
3757
3826
  /** The hour count of the timer */
3758
3827
  hours: number;
3759
3828
  /** The minute count of the timer */
3760
3829
  minutes: number;
3761
- /** flag to indicate if timer is running or not */
3762
- running: boolean;
3763
3830
  /** The second count of the timer */
3764
3831
  seconds: number;
3765
3832
  /** The function to pause the timer */
3766
3833
  pause: () => void;
3767
3834
  /** The function to restart the timer */
3768
- restart: (time: number, autostart?: boolean) => void;
3835
+ restart: (time: number, immediately?: boolean) => void;
3836
+ /** The function to resume the timer */
3837
+ resume: () => void;
3769
3838
  /** The function to start the timer */
3770
3839
  start: () => void;
3771
3840
  /** The function to toggle the timer */
@@ -3785,16 +3854,16 @@ interface UseTimer {
3785
3854
  * @param {() => void} callback The function to be executed once countdown timer is expired
3786
3855
  *
3787
3856
  * @example
3788
- * const { days, hours, minutes, seconds, toggle, pause, start, restart, running } = useTimer(1000, () => console.log('ready'));
3857
+ * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active } = useTimer(1000, () => console.log('ready'));
3789
3858
  *
3790
3859
  * @overload
3791
3860
  * @param {number} timestamp The timestamp value that define for how long the timer will be running
3792
- * @param {boolean} options.autostart The flag to decide if timer should start automatically
3861
+ * @param {boolean} options.immediately The flag to decide if timer should start automatically
3793
3862
  * @param {() => void} options.onExpire The function to be executed when the timer is expired
3794
3863
  * @param {(timestamp: number) => void} options.onTick The function to be executed on each tick of the timer
3795
3864
  *
3796
3865
  * @example
3797
- * const { days, hours, minutes, seconds, toggle, pause, start, restart, running } = useTimer(1000);
3866
+ * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active } = useTimer(1000);
3798
3867
  */
3799
3868
  declare const useTimer: UseTimer;
3800
3869
 
@@ -3851,6 +3920,8 @@ interface UseVibrateReturn {
3851
3920
  * @description - Hook that provides vibrate api
3852
3921
  * @category Browser
3853
3922
  *
3923
+ * @browserapi navigator.vibrate https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate
3924
+ *
3854
3925
  * @overload
3855
3926
  * @param {UseVibratePattern} options.pattern The pattern for vibration
3856
3927
  * @param {number} [options.interval=0] Time in milliseconds between vibrations
@@ -3888,7 +3959,7 @@ interface UseWebSocketReturn {
3888
3959
  /**
3889
3960
  * @name useWebSocket
3890
3961
  * @description - Hook that connects to a WebSocket server and handles incoming and outgoing messages
3891
- * @category Network
3962
+ * @category Browser
3892
3963
  *
3893
3964
  * @param {UseWebSocketUrl} url The URL of the WebSocket server
3894
3965
  * @param {(webSocket: WebSocket) => void} [options.onConnected] The callback function that is called when the WebSocket connection is established
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@siberiacancode/reactuse",
3
- "version": "0.0.99",
3
+ "version": "0.0.101",
4
4
  "description": "The ultimate collection of react hooks",
5
5
  "author": {
6
6
  "name": "SIBERIA CAN CODE 🧊",
@@ -1 +0,0 @@
1
- {"version":3,"file":"_rollupPluginBabelHelpers-C-GU1yny.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
@@ -1,3 +0,0 @@
1
- /* @license @siberiacancode/reactuse v0.0.99 */
2
- "use strict";var o=require("./mapGamepadToXbox360Controller.js");exports.mapGamepadToXbox360Controller=o.mapGamepadToXbox360Controller;
3
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
@@ -1,3 +0,0 @@
1
- /* @license @siberiacancode/reactuse v0.0.99 */
2
- "use strict";exports.mapGamepadToXbox360Controller=function(t){return{buttons:{a:t.buttons[0],b:t.buttons[1],x:t.buttons[2],y:t.buttons[3]},bumper:{left:t.buttons[4],right:t.buttons[5]},triggers:{left:t.buttons[6],right:t.buttons[7]},stick:{left:{horizontal:t.axes[0],vertical:t.axes[1],button:t.buttons[10]},right:{horizontal:t.axes[2],vertical:t.axes[3],button:t.buttons[11]}},dpad:{up:t.buttons[12],down:t.buttons[13],left:t.buttons[14],right:t.buttons[15]},back:t.buttons[8],start:t.buttons[9]}};
3
- //# sourceMappingURL=mapGamepadToXbox360Controller.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mapGamepadToXbox360Controller.js","sources":["../../../../../src/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.ts"],"sourcesContent":["export const mapGamepadToXbox360Controller = (gamepad: Gamepad) => ({\n buttons: {\n a: gamepad.buttons[0],\n b: gamepad.buttons[1],\n x: gamepad.buttons[2],\n y: gamepad.buttons[3]\n },\n bumper: {\n left: gamepad.buttons[4],\n right: gamepad.buttons[5]\n },\n triggers: {\n left: gamepad.buttons[6],\n right: gamepad.buttons[7]\n },\n stick: {\n left: {\n horizontal: gamepad.axes[0],\n vertical: gamepad.axes[1],\n button: gamepad.buttons[10]\n },\n right: {\n horizontal: gamepad.axes[2],\n vertical: gamepad.axes[3],\n button: gamepad.buttons[11]\n }\n },\n dpad: {\n up: gamepad.buttons[12],\n down: gamepad.buttons[13],\n left: gamepad.buttons[14],\n right: gamepad.buttons[15]\n },\n back: gamepad.buttons[8],\n start: gamepad.buttons[9]\n});\n"],"names":["gamepad","buttons","a","b","x","y","bumper","left","right","triggers","stick","horizontal","axes","vertical","button","dpad","up","down","back","start"],"mappings":";mDAA6C,SAACA,GAAgB,MAAM,CAClEC,QAAS,CACPC,EAAGF,EAAQC,QAAQ,GACnBE,EAAGH,EAAQC,QAAQ,GACnBG,EAAGJ,EAAQC,QAAQ,GACnBI,EAAGL,EAAQC,QAAQ,IAErBK,OAAQ,CACNC,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBQ,SAAU,CACRF,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBS,MAAO,CACLH,KAAM,CACJI,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,KAE1BO,MAAO,CACLG,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,MAG5Bc,KAAM,CACJC,GAAIhB,EAAQC,QAAQ,IACpBgB,KAAMjB,EAAQC,QAAQ,IACtBM,KAAMP,EAAQC,QAAQ,IACtBO,MAAOR,EAAQC,QAAQ,KAEzBiB,KAAMlB,EAAQC,QAAQ,GACtBkB,MAAOnB,EAAQC,QAAQ,GACxB"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"_rollupPluginBabelHelpers-D_XDB4a1.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
@@ -1,3 +0,0 @@
1
- /* @license @siberiacancode/reactuse v0.0.99 */
2
- export{mapGamepadToXbox360Controller}from"./mapGamepadToXbox360Controller.js";
3
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
@@ -1,3 +0,0 @@
1
- /* @license @siberiacancode/reactuse v0.0.99 */
2
- var t=function(t){return{buttons:{a:t.buttons[0],b:t.buttons[1],x:t.buttons[2],y:t.buttons[3]},bumper:{left:t.buttons[4],right:t.buttons[5]},triggers:{left:t.buttons[6],right:t.buttons[7]},stick:{left:{horizontal:t.axes[0],vertical:t.axes[1],button:t.buttons[10]},right:{horizontal:t.axes[2],vertical:t.axes[3],button:t.buttons[11]}},dpad:{up:t.buttons[12],down:t.buttons[13],left:t.buttons[14],right:t.buttons[15]},back:t.buttons[8],start:t.buttons[9]}};export{t as mapGamepadToXbox360Controller};
3
- //# sourceMappingURL=mapGamepadToXbox360Controller.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mapGamepadToXbox360Controller.js","sources":["../../../../../src/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.ts"],"sourcesContent":["export const mapGamepadToXbox360Controller = (gamepad: Gamepad) => ({\n buttons: {\n a: gamepad.buttons[0],\n b: gamepad.buttons[1],\n x: gamepad.buttons[2],\n y: gamepad.buttons[3]\n },\n bumper: {\n left: gamepad.buttons[4],\n right: gamepad.buttons[5]\n },\n triggers: {\n left: gamepad.buttons[6],\n right: gamepad.buttons[7]\n },\n stick: {\n left: {\n horizontal: gamepad.axes[0],\n vertical: gamepad.axes[1],\n button: gamepad.buttons[10]\n },\n right: {\n horizontal: gamepad.axes[2],\n vertical: gamepad.axes[3],\n button: gamepad.buttons[11]\n }\n },\n dpad: {\n up: gamepad.buttons[12],\n down: gamepad.buttons[13],\n left: gamepad.buttons[14],\n right: gamepad.buttons[15]\n },\n back: gamepad.buttons[8],\n start: gamepad.buttons[9]\n});\n"],"names":["mapGamepadToXbox360Controller","gamepad","buttons","a","b","x","y","bumper","left","right","triggers","stick","horizontal","axes","vertical","button","dpad","up","down","back","start"],"mappings":";IAAaA,EAAgC,SAACC,GAAgB,MAAM,CAClEC,QAAS,CACPC,EAAGF,EAAQC,QAAQ,GACnBE,EAAGH,EAAQC,QAAQ,GACnBG,EAAGJ,EAAQC,QAAQ,GACnBI,EAAGL,EAAQC,QAAQ,IAErBK,OAAQ,CACNC,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBQ,SAAU,CACRF,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBS,MAAO,CACLH,KAAM,CACJI,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,KAE1BO,MAAO,CACLG,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,MAG5Bc,KAAM,CACJC,GAAIhB,EAAQC,QAAQ,IACpBgB,KAAMjB,EAAQC,QAAQ,IACtBM,KAAMP,EAAQC,QAAQ,IACtBO,MAAOR,EAAQC,QAAQ,KAEzBiB,KAAMlB,EAAQC,QAAQ,GACtBkB,MAAOnB,EAAQC,QAAQ,GACxB"}