@siberiacancode/reactuse 0.3.2 → 0.3.4

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 (227) hide show
  1. package/dist/cjs/hooks/useActiveElement/useActiveElement.cjs +1 -1
  2. package/dist/cjs/hooks/useActiveElement/useActiveElement.cjs.map +1 -1
  3. package/dist/cjs/hooks/useAudio/useAudio.cjs +1 -1
  4. package/dist/cjs/hooks/useAudio/useAudio.cjs.map +1 -1
  5. package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs +1 -1
  6. package/dist/cjs/hooks/useAutoScroll/useAutoScroll.cjs.map +1 -1
  7. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.cjs +1 -1
  8. package/dist/cjs/hooks/useBreakpoints/useBreakpoints.cjs.map +1 -1
  9. package/dist/cjs/hooks/useClickOutside/useClickOutside.cjs +1 -1
  10. package/dist/cjs/hooks/useClickOutside/useClickOutside.cjs.map +1 -1
  11. package/dist/cjs/hooks/useCookie/useCookie.cjs +1 -1
  12. package/dist/cjs/hooks/useCookie/useCookie.cjs.map +1 -1
  13. package/dist/cjs/hooks/useCounter/useCounter.cjs +1 -1
  14. package/dist/cjs/hooks/useCounter/useCounter.cjs.map +1 -1
  15. package/dist/cjs/hooks/useCssVar/useCssVar.cjs +1 -1
  16. package/dist/cjs/hooks/useCssVar/useCssVar.cjs.map +1 -1
  17. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.cjs +1 -1
  18. package/dist/cjs/hooks/useDeviceMotion/useDeviceMotion.cjs.map +1 -1
  19. package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.cjs +1 -1
  20. package/dist/cjs/hooks/useDisplayMedia/useDisplayMedia.cjs.map +1 -1
  21. package/dist/cjs/hooks/useDoubleClick/useDoubleClick.cjs +1 -1
  22. package/dist/cjs/hooks/useDoubleClick/useDoubleClick.cjs.map +1 -1
  23. package/dist/cjs/hooks/useDropZone/useDropZone.cjs +1 -1
  24. package/dist/cjs/hooks/useDropZone/useDropZone.cjs.map +1 -1
  25. package/dist/cjs/hooks/useElementSize/useElementSize.cjs +1 -1
  26. package/dist/cjs/hooks/useElementSize/useElementSize.cjs.map +1 -1
  27. package/dist/cjs/hooks/useEventListener/useEventListener.cjs +1 -1
  28. package/dist/cjs/hooks/useEventListener/useEventListener.cjs.map +1 -1
  29. package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs +1 -1
  30. package/dist/cjs/hooks/useFileDialog/useFileDialog.cjs.map +1 -1
  31. package/dist/cjs/hooks/useFocus/useFocus.cjs +1 -1
  32. package/dist/cjs/hooks/useFocus/useFocus.cjs.map +1 -1
  33. package/dist/cjs/hooks/useFocusTrap/useFocusTrap.cjs +1 -1
  34. package/dist/cjs/hooks/useFocusTrap/useFocusTrap.cjs.map +1 -1
  35. package/dist/cjs/hooks/useFullscreen/useFullscreen.cjs +1 -1
  36. package/dist/cjs/hooks/useFullscreen/useFullscreen.cjs.map +1 -1
  37. package/dist/cjs/hooks/useHash/useHash.cjs +1 -1
  38. package/dist/cjs/hooks/useHash/useHash.cjs.map +1 -1
  39. package/dist/cjs/hooks/useHotkeys/useHotkeys.cjs +1 -1
  40. package/dist/cjs/hooks/useHotkeys/useHotkeys.cjs.map +1 -1
  41. package/dist/cjs/hooks/useHover/useHover.cjs +1 -1
  42. package/dist/cjs/hooks/useHover/useHover.cjs.map +1 -1
  43. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.cjs +1 -1
  44. package/dist/cjs/hooks/useInfiniteScroll/useInfiniteScroll.cjs.map +1 -1
  45. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs +1 -1
  46. package/dist/cjs/hooks/useIntersectionObserver/useIntersectionObserver.cjs.map +1 -1
  47. package/dist/cjs/hooks/useInterval/useInterval.cjs +1 -1
  48. package/dist/cjs/hooks/useInterval/useInterval.cjs.map +1 -1
  49. package/dist/cjs/hooks/useKeyPress/useKeyPress.cjs +1 -1
  50. package/dist/cjs/hooks/useKeyPress/useKeyPress.cjs.map +1 -1
  51. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.cjs +1 -1
  52. package/dist/cjs/hooks/useKeyPressEvent/useKeyPressEvent.cjs.map +1 -1
  53. package/dist/cjs/hooks/useKeyboard/useKeyboard.cjs +1 -1
  54. package/dist/cjs/hooks/useKeyboard/useKeyboard.cjs.map +1 -1
  55. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.cjs +1 -1
  56. package/dist/cjs/hooks/useKeysPressed/useKeysPressed.cjs.map +1 -1
  57. package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs +1 -1
  58. package/dist/cjs/hooks/useLockScroll/useLockScroll.cjs.map +1 -1
  59. package/dist/cjs/hooks/useLongPress/useLongPress.cjs +1 -1
  60. package/dist/cjs/hooks/useLongPress/useLongPress.cjs.map +1 -1
  61. package/dist/cjs/hooks/useMeasure/useMeasure.cjs +1 -1
  62. package/dist/cjs/hooks/useMeasure/useMeasure.cjs.map +1 -1
  63. package/dist/cjs/hooks/useMediaControls/useMediaControls.cjs +1 -1
  64. package/dist/cjs/hooks/useMediaControls/useMediaControls.cjs.map +1 -1
  65. package/dist/cjs/hooks/useMouse/useMouse.cjs +1 -1
  66. package/dist/cjs/hooks/useMouse/useMouse.cjs.map +1 -1
  67. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs +1 -1
  68. package/dist/cjs/hooks/useMutationObserver/useMutationObserver.cjs.map +1 -1
  69. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs +1 -1
  70. package/dist/cjs/hooks/useOtpCredential/useOtpCredential.cjs.map +1 -1
  71. package/dist/cjs/hooks/usePaint/usePaint.cjs +1 -1
  72. package/dist/cjs/hooks/usePaint/usePaint.cjs.map +1 -1
  73. package/dist/cjs/hooks/useParallax/useParallax.cjs +1 -1
  74. package/dist/cjs/hooks/useParallax/useParallax.cjs.map +1 -1
  75. package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs +1 -1
  76. package/dist/cjs/hooks/usePictureInPicture/usePictureInPicture.cjs.map +1 -1
  77. package/dist/cjs/hooks/useRefState/useRefState.cjs +1 -1
  78. package/dist/cjs/hooks/useRefState/useRefState.cjs.map +1 -1
  79. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs +1 -1
  80. package/dist/cjs/hooks/useResizeObserver/useResizeObserver.cjs.map +1 -1
  81. package/dist/cjs/hooks/useRightClick/useRightClick.cjs +1 -1
  82. package/dist/cjs/hooks/useRightClick/useRightClick.cjs.map +1 -1
  83. package/dist/cjs/hooks/useScroll/useScroll.cjs +1 -1
  84. package/dist/cjs/hooks/useScroll/useScroll.cjs.map +1 -1
  85. package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs +1 -1
  86. package/dist/cjs/hooks/useScrollIntoView/useScrollIntoView.cjs.map +1 -1
  87. package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs +1 -1
  88. package/dist/cjs/hooks/useScrollTo/useScrollTo.cjs.map +1 -1
  89. package/dist/cjs/hooks/useSticky/useSticky.cjs +1 -1
  90. package/dist/cjs/hooks/useSticky/useSticky.cjs.map +1 -1
  91. package/dist/cjs/hooks/useStopwatch/useStopwatch.cjs +1 -1
  92. package/dist/cjs/hooks/useStopwatch/useStopwatch.cjs.map +1 -1
  93. package/dist/cjs/hooks/useStorage/useStorage.cjs +1 -1
  94. package/dist/cjs/hooks/useStorage/useStorage.cjs.map +1 -1
  95. package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs +1 -1
  96. package/dist/cjs/hooks/useTextDirection/useTextDirection.cjs.map +1 -1
  97. package/dist/cjs/hooks/useTextareaAutosize/useTextareaAutosize.cjs +2 -0
  98. package/dist/cjs/hooks/useTextareaAutosize/useTextareaAutosize.cjs.map +1 -0
  99. package/dist/cjs/hooks/useTimer/useTimer.cjs +1 -1
  100. package/dist/cjs/hooks/useTimer/useTimer.cjs.map +1 -1
  101. package/dist/cjs/hooks/useUrlSearchParam/useUrlSearchParam.cjs +1 -1
  102. package/dist/cjs/hooks/useUrlSearchParam/useUrlSearchParam.cjs.map +1 -1
  103. package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs +1 -1
  104. package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs.map +1 -1
  105. package/dist/cjs/hooks/useVisibility/useVisibility.cjs +1 -1
  106. package/dist/cjs/hooks/useVisibility/useVisibility.cjs.map +1 -1
  107. package/dist/cjs/index.cjs +1 -1
  108. package/dist/cjs/utils/helpers/isTarget.cjs +1 -1
  109. package/dist/cjs/utils/helpers/isTarget.cjs.map +1 -1
  110. package/dist/esm/hooks/useActiveElement/useActiveElement.mjs +13 -13
  111. package/dist/esm/hooks/useActiveElement/useActiveElement.mjs.map +1 -1
  112. package/dist/esm/hooks/useAudio/useAudio.mjs +29 -23
  113. package/dist/esm/hooks/useAudio/useAudio.mjs.map +1 -1
  114. package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs +24 -24
  115. package/dist/esm/hooks/useAutoScroll/useAutoScroll.mjs.map +1 -1
  116. package/dist/esm/hooks/useBreakpoints/useBreakpoints.mjs +30 -35
  117. package/dist/esm/hooks/useBreakpoints/useBreakpoints.mjs.map +1 -1
  118. package/dist/esm/hooks/useClickOutside/useClickOutside.mjs +15 -14
  119. package/dist/esm/hooks/useClickOutside/useClickOutside.mjs.map +1 -1
  120. package/dist/esm/hooks/useCookie/useCookie.mjs +2 -2
  121. package/dist/esm/hooks/useCookie/useCookie.mjs.map +1 -1
  122. package/dist/esm/hooks/useCounter/useCounter.mjs +2 -2
  123. package/dist/esm/hooks/useCounter/useCounter.mjs.map +1 -1
  124. package/dist/esm/hooks/useCssVar/useCssVar.mjs +8 -8
  125. package/dist/esm/hooks/useCssVar/useCssVar.mjs.map +1 -1
  126. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.mjs +2 -2
  127. package/dist/esm/hooks/useDeviceMotion/useDeviceMotion.mjs.map +1 -1
  128. package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.mjs +17 -17
  129. package/dist/esm/hooks/useDisplayMedia/useDisplayMedia.mjs.map +1 -1
  130. package/dist/esm/hooks/useDoubleClick/useDoubleClick.mjs +14 -14
  131. package/dist/esm/hooks/useDoubleClick/useDoubleClick.mjs.map +1 -1
  132. package/dist/esm/hooks/useDropZone/useDropZone.mjs +23 -23
  133. package/dist/esm/hooks/useDropZone/useDropZone.mjs.map +1 -1
  134. package/dist/esm/hooks/useElementSize/useElementSize.mjs +14 -14
  135. package/dist/esm/hooks/useElementSize/useElementSize.mjs.map +1 -1
  136. package/dist/esm/hooks/useEventListener/useEventListener.mjs +14 -14
  137. package/dist/esm/hooks/useEventListener/useEventListener.mjs.map +1 -1
  138. package/dist/esm/hooks/useFileDialog/useFileDialog.mjs +2 -2
  139. package/dist/esm/hooks/useFileDialog/useFileDialog.mjs.map +1 -1
  140. package/dist/esm/hooks/useFocus/useFocus.mjs +20 -20
  141. package/dist/esm/hooks/useFocus/useFocus.mjs.map +1 -1
  142. package/dist/esm/hooks/useFocusTrap/useFocusTrap.mjs +21 -21
  143. package/dist/esm/hooks/useFocusTrap/useFocusTrap.mjs.map +1 -1
  144. package/dist/esm/hooks/useFullscreen/useFullscreen.mjs +2 -2
  145. package/dist/esm/hooks/useFullscreen/useFullscreen.mjs.map +1 -1
  146. package/dist/esm/hooks/useHash/useHash.mjs +2 -2
  147. package/dist/esm/hooks/useHash/useHash.mjs.map +1 -1
  148. package/dist/esm/hooks/useHotkeys/useHotkeys.mjs +24 -16
  149. package/dist/esm/hooks/useHotkeys/useHotkeys.mjs.map +1 -1
  150. package/dist/esm/hooks/useHover/useHover.mjs +16 -16
  151. package/dist/esm/hooks/useHover/useHover.mjs.map +1 -1
  152. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.mjs +16 -16
  153. package/dist/esm/hooks/useInfiniteScroll/useInfiniteScroll.mjs.map +1 -1
  154. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs +26 -18
  155. package/dist/esm/hooks/useIntersectionObserver/useIntersectionObserver.mjs.map +1 -1
  156. package/dist/esm/hooks/useInterval/useInterval.mjs +2 -2
  157. package/dist/esm/hooks/useInterval/useInterval.mjs.map +1 -1
  158. package/dist/esm/hooks/useKeyPress/useKeyPress.mjs +15 -15
  159. package/dist/esm/hooks/useKeyPress/useKeyPress.mjs.map +1 -1
  160. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.mjs +22 -15
  161. package/dist/esm/hooks/useKeyPressEvent/useKeyPressEvent.mjs.map +1 -1
  162. package/dist/esm/hooks/useKeyboard/useKeyboard.mjs +10 -10
  163. package/dist/esm/hooks/useKeyboard/useKeyboard.mjs.map +1 -1
  164. package/dist/esm/hooks/useKeysPressed/useKeysPressed.mjs +12 -12
  165. package/dist/esm/hooks/useKeysPressed/useKeysPressed.mjs.map +1 -1
  166. package/dist/esm/hooks/useLockScroll/useLockScroll.mjs +23 -23
  167. package/dist/esm/hooks/useLockScroll/useLockScroll.mjs.map +1 -1
  168. package/dist/esm/hooks/useLongPress/useLongPress.mjs +16 -16
  169. package/dist/esm/hooks/useLongPress/useLongPress.mjs.map +1 -1
  170. package/dist/esm/hooks/useMeasure/useMeasure.mjs +15 -15
  171. package/dist/esm/hooks/useMeasure/useMeasure.mjs.map +1 -1
  172. package/dist/esm/hooks/useMediaControls/useMediaControls.mjs +28 -28
  173. package/dist/esm/hooks/useMediaControls/useMediaControls.mjs.map +1 -1
  174. package/dist/esm/hooks/useMouse/useMouse.mjs +17 -17
  175. package/dist/esm/hooks/useMouse/useMouse.mjs.map +1 -1
  176. package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs +17 -16
  177. package/dist/esm/hooks/useMutationObserver/useMutationObserver.mjs.map +1 -1
  178. package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs +2 -2
  179. package/dist/esm/hooks/useOtpCredential/useOtpCredential.mjs.map +1 -1
  180. package/dist/esm/hooks/usePaint/usePaint.mjs +31 -31
  181. package/dist/esm/hooks/usePaint/usePaint.mjs.map +1 -1
  182. package/dist/esm/hooks/useParallax/useParallax.mjs +24 -23
  183. package/dist/esm/hooks/useParallax/useParallax.mjs.map +1 -1
  184. package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs +25 -25
  185. package/dist/esm/hooks/usePictureInPicture/usePictureInPicture.mjs.map +1 -1
  186. package/dist/esm/hooks/useRefState/useRefState.mjs +1 -0
  187. package/dist/esm/hooks/useRefState/useRefState.mjs.map +1 -1
  188. package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs +16 -16
  189. package/dist/esm/hooks/useResizeObserver/useResizeObserver.mjs.map +1 -1
  190. package/dist/esm/hooks/useRightClick/useRightClick.mjs +14 -14
  191. package/dist/esm/hooks/useRightClick/useRightClick.mjs.map +1 -1
  192. package/dist/esm/hooks/useScroll/useScroll.mjs +22 -22
  193. package/dist/esm/hooks/useScroll/useScroll.mjs.map +1 -1
  194. package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs +16 -16
  195. package/dist/esm/hooks/useScrollIntoView/useScrollIntoView.mjs.map +1 -1
  196. package/dist/esm/hooks/useScrollTo/useScrollTo.mjs +10 -10
  197. package/dist/esm/hooks/useScrollTo/useScrollTo.mjs.map +1 -1
  198. package/dist/esm/hooks/useSticky/useSticky.mjs +17 -17
  199. package/dist/esm/hooks/useSticky/useSticky.mjs.map +1 -1
  200. package/dist/esm/hooks/useStopwatch/useStopwatch.mjs +4 -4
  201. package/dist/esm/hooks/useStopwatch/useStopwatch.mjs.map +1 -1
  202. package/dist/esm/hooks/useStorage/useStorage.mjs +2 -2
  203. package/dist/esm/hooks/useStorage/useStorage.mjs.map +1 -1
  204. package/dist/esm/hooks/useTextDirection/useTextDirection.mjs +12 -12
  205. package/dist/esm/hooks/useTextDirection/useTextDirection.mjs.map +1 -1
  206. package/dist/esm/hooks/useTextareaAutosize/useTextareaAutosize.mjs +58 -0
  207. package/dist/esm/hooks/useTextareaAutosize/useTextareaAutosize.mjs.map +1 -0
  208. package/dist/esm/hooks/useTimer/useTimer.mjs +3 -3
  209. package/dist/esm/hooks/useTimer/useTimer.mjs.map +1 -1
  210. package/dist/esm/hooks/useUrlSearchParam/useUrlSearchParam.mjs +2 -2
  211. package/dist/esm/hooks/useUrlSearchParam/useUrlSearchParam.mjs.map +1 -1
  212. package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs +2 -2
  213. package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs.map +1 -1
  214. package/dist/esm/hooks/useVisibility/useVisibility.mjs +25 -17
  215. package/dist/esm/hooks/useVisibility/useVisibility.mjs.map +1 -1
  216. package/dist/esm/index.mjs +255 -251
  217. package/dist/esm/index.mjs.map +1 -1
  218. package/dist/esm/utils/helpers/isTarget.mjs +10 -8
  219. package/dist/esm/utils/helpers/isTarget.mjs.map +1 -1
  220. package/dist/types/hooks/elements.d.ts +1 -0
  221. package/dist/types/hooks/useBreakpoints/useBreakpoints.d.ts +1 -11
  222. package/dist/types/hooks/useClickOutside/useClickOutside.d.ts +1 -1
  223. package/dist/types/hooks/useHover/useHover.d.ts +6 -6
  224. package/dist/types/hooks/useRefState/useRefState.d.ts +1 -0
  225. package/dist/types/hooks/useTextareaAutosize/useTextareaAutosize.d.ts +60 -0
  226. package/dist/types/utils/helpers/isTarget.d.ts +9 -1
  227. package/package.json +12 -12
@@ -1 +1 @@
1
- {"version":3,"file":"useTimer.mjs","sources":["../../../../src/hooks/useTimer/useTimer.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport { useDidUpdate } from '../useDidUpdate/useDidUpdate';\n\nexport type PositiveInteger<Value extends number> = `${Value}` extends `-${any}` | `${any}.${any}`\n ? never\n : Value;\n\nexport const getTimeFromSeconds = (timestamp: number) => {\n const roundedTimestamp = Math.ceil(timestamp);\n const days = Math.floor(roundedTimestamp / (60 * 60 * 24));\n const hours = Math.floor((roundedTimestamp % (60 * 60 * 24)) / (60 * 60));\n const minutes = Math.floor((roundedTimestamp % (60 * 60)) / 60);\n const seconds = Math.floor(roundedTimestamp % 60);\n\n return {\n seconds,\n minutes,\n hours,\n days\n };\n};\n\n/** The use timer options type */\nexport interface UseTimerOptions {\n /** Whether the timer should start automatically */\n immediately?: boolean;\n /** The function to be executed when the timer is expired */\n onExpire?: () => void;\n /** The function to be executed when the timer is started */\n onStart?: () => void;\n /** Callback function to be executed on each tick of the timer */\n onTick?: (seconds: number) => void;\n}\n\n/** The use timer return type */\nexport interface UseTimerReturn {\n /** flag to indicate if timer is active or not */\n active: boolean;\n /** The total count of the timer */\n count: number;\n /** The day count of the timer */\n days: number;\n /** The hour count of the timer */\n hours: number;\n /** The minute count of the timer */\n minutes: number;\n /** The second count of the timer */\n seconds: number;\n /** The function to clear the timer */\n clear: () => void;\n /** The function to decrease the timer */\n decrease: (seconds: PositiveInteger<number>) => void;\n /** The function to increase the timer */\n increase: (seconds: PositiveInteger<number>) => void;\n /** The function to pause the timer */\n pause: () => void;\n /** The function to restart the timer */\n restart: (time: PositiveInteger<number>, immediately?: boolean) => void;\n /** The function to resume the timer */\n resume: () => void;\n /** The function to start the timer */\n start: () => void;\n /** The function to toggle the timer */\n toggle: () => void;\n}\n\nexport interface UseTimer {\n (): UseTimerReturn;\n\n (seconds: PositiveInteger<number>, callback: () => void): UseTimerReturn;\n\n (seconds: PositiveInteger<number>, options?: UseTimerOptions): UseTimerReturn;\n}\n\n/**\n * @name useTimer\n * @description - Hook that creates a timer functionality\n * @category Time\n * @usage medium\n *\n * @overload\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer();\n *\n * @overload\n * @param {number} seconds The seconds value that define for how long the timer will be running\n * @param {() => void} callback The function to be executed once countdown timer is expired\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer(1000, () => console.log('ready'));\n *\n * @overload\n * @param {number} seconds The seconds value that define for how long the timer will be running\n * @param {boolean} [options.immediately=true] The flag to decide if timer should start automatically\n * @param {() => void} [options.onExpire] The function to be executed when the timer is expired\n * @param {(timestamp: number) => void} [options.onTick] The function to be executed on each tick of the timer\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer(1000);\n */\nexport const useTimer = ((...params: any[]) => {\n const initialSeconds = Math.max((params[0] ?? 0) as PositiveInteger<number>, 0);\n const options = (typeof params[1] === 'object' ? params[1] : { onExpire: params[1] }) as\n | UseTimerOptions\n | undefined;\n\n const [active, setActive] = useState(initialSeconds > 0 && (options?.immediately ?? true));\n const [seconds, setSeconds] = useState(initialSeconds);\n\n const intervalIdRef = useRef<ReturnType<typeof setInterval>>(undefined);\n const optionsRef = useRef<UseTimerOptions>(options);\n optionsRef.current = options ?? {};\n\n useDidUpdate(() => {\n if (initialSeconds <= 0) {\n setActive(false);\n setSeconds(0);\n return;\n }\n\n setActive(true);\n setSeconds(initialSeconds);\n }, [initialSeconds]);\n\n useEffect(() => {\n if (!active) return;\n\n optionsRef.current?.onStart?.();\n const onInterval = () => {\n setSeconds((prevSeconds) => {\n optionsRef.current?.onTick?.(prevSeconds);\n const updatedSeconds = prevSeconds - 1;\n if (updatedSeconds === 0) {\n setActive(false);\n optionsRef.current?.onExpire?.();\n }\n return updatedSeconds;\n });\n };\n\n intervalIdRef.current = setInterval(onInterval, 1000);\n return () => {\n clearInterval(intervalIdRef.current);\n };\n }, [active]);\n\n const pause = () => setActive(false);\n const resume = () => {\n if (seconds <= 0) return;\n setActive(true);\n };\n\n const toggle = () => {\n if (seconds <= 0) return;\n setActive(!active);\n };\n\n const restart = (seconds: PositiveInteger<number>, immediately = true) => {\n setSeconds(seconds);\n if (immediately) setActive(true);\n };\n\n const start = () => {\n if (initialSeconds <= 0) return;\n\n setActive(true);\n setSeconds(initialSeconds);\n };\n\n const clear = () => {\n setActive(false);\n setSeconds(0);\n };\n\n const increase = (seconds: PositiveInteger<number>) =>\n setSeconds((prevSeconds) => prevSeconds + seconds);\n const decrease = (seconds: PositiveInteger<number>) => {\n setSeconds((prevSeconds) => {\n const updatedSeconds = prevSeconds - seconds;\n if (updatedSeconds <= 0) {\n setActive(false);\n return 0;\n } else {\n return updatedSeconds;\n }\n });\n };\n\n return {\n ...getTimeFromSeconds(seconds),\n count: seconds,\n pause,\n active,\n resume,\n toggle,\n start,\n restart,\n clear,\n increase,\n decrease\n };\n}) as UseTimer;\n"],"names":["getTimeFromSeconds","timestamp","roundedTimestamp","days","hours","minutes","useTimer","params","initialSeconds","options","active","setActive","useState","seconds","setSeconds","intervalIdRef","useRef","optionsRef","useDidUpdate","useEffect","onInterval","prevSeconds","updatedSeconds","pause","resume","toggle","restart","immediately","start","clear","increase","decrease"],"mappings":";;AAQO,MAAMA,IAAqB,CAACC,MAAsB;AACvD,QAAMC,IAAmB,KAAK,KAAKD,CAAS,GACtCE,IAAO,KAAK,MAAMD,KAAoB,KAAK,KAAK,GAAG,GACnDE,IAAQ,KAAK,MAAOF,KAAoB,KAAK,KAAK,OAAQ,KAAK,GAAG,GAClEG,IAAU,KAAK,MAAOH,KAAoB,KAAK,MAAO,EAAE;AAG9D,SAAO;AAAA,IACL,SAHc,KAAK,MAAMA,IAAmB,EAAE;AAAA,IAI9C,SAAAG;AAAA,IACA,OAAAD;AAAA,IACA,MAAAD;AAAA,EAAA;AAEJ,GAoFaG,IAAY,IAAIC,MAAkB;AAC7C,QAAMC,IAAiB,KAAK,IAAKD,EAAO,CAAC,KAAK,GAA+B,CAAC,GACxEE,IAAW,OAAOF,EAAO,CAAC,KAAM,WAAWA,EAAO,CAAC,IAAI,EAAE,UAAUA,EAAO,CAAC,EAAA,GAI3E,CAACG,GAAQC,CAAS,IAAIC,EAASJ,IAAiB,MAAMC,GAAS,eAAe,GAAK,GACnF,CAACI,GAASC,CAAU,IAAIF,EAASJ,CAAc,GAE/CO,IAAgBC,EAAuC,MAAS,GAChEC,IAAaD,EAAwBP,CAAO;AAClD,EAAAQ,EAAW,UAAUR,KAAW,CAAA,GAEhCS,EAAa,MAAM;AACjB,QAAIV,KAAkB,GAAG;AACvB,MAAAG,EAAU,EAAK,GACfG,EAAW,CAAC;AACZ;AAAA,IAAA;AAGF,IAAAH,EAAU,EAAI,GACdG,EAAWN,CAAc;AAAA,EAAA,GACxB,CAACA,CAAc,CAAC,GAEnBW,EAAU,MAAM;AACd,QAAI,CAACT,EAAQ;AAEb,IAAAO,EAAW,SAAS,UAAA;AACpB,UAAMG,IAAa,MAAM;AACvB,MAAAN,EAAW,CAACO,MAAgB;AAC1B,QAAAJ,EAAW,SAAS,SAASI,CAAW;AACxC,cAAMC,IAAiBD,IAAc;AACrC,eAAIC,MAAmB,MACrBX,EAAU,EAAK,GACfM,EAAW,SAAS,WAAA,IAEfK;AAAA,MAAA,CACR;AAAA,IAAA;AAGH,WAAAP,EAAc,UAAU,YAAYK,GAAY,GAAI,GAC7C,MAAM;AACX,oBAAcL,EAAc,OAAO;AAAA,IAAA;AAAA,EACrC,GACC,CAACL,CAAM,CAAC;AAEX,QAAMa,IAAQ,MAAMZ,EAAU,EAAK,GAC7Ba,IAAS,MAAM;AACnB,IAAIX,KAAW,KACfF,EAAU,EAAI;AAAA,EAAA,GAGVc,IAAS,MAAM;AACnB,IAAIZ,KAAW,KACfF,EAAU,CAACD,CAAM;AAAA,EAAA,GAGbgB,IAAU,CAACb,GAAkCc,IAAc,OAAS;AACxE,IAAAb,EAAWD,CAAO,GACdc,OAAuB,EAAI;AAAA,EAAA,GAG3BC,IAAQ,MAAM;AAClB,IAAIpB,KAAkB,MAEtBG,EAAU,EAAI,GACdG,EAAWN,CAAc;AAAA,EAAA,GAGrBqB,IAAQ,MAAM;AAClB,IAAAlB,EAAU,EAAK,GACfG,EAAW,CAAC;AAAA,EAAA,GAGRgB,IAAW,CAACjB,MAChBC,EAAW,CAACO,MAAgBA,IAAcR,CAAO,GAC7CkB,IAAW,CAAClB,MAAqC;AACrD,IAAAC,EAAW,CAACO,MAAgB;AAC1B,YAAMC,IAAiBD,IAAcR;AACrC,aAAIS,KAAkB,KACpBX,EAAU,EAAK,GACR,KAEAW;AAAA,IACT,CACD;AAAA,EAAA;AAGH,SAAO;AAAA,IACL,GAAGtB,EAAmBa,CAAO;AAAA,IAC7B,OAAOA;AAAA,IACP,OAAAU;AAAA,IACA,QAAAb;AAAA,IACA,QAAAc;AAAA,IACA,QAAAC;AAAA,IACA,OAAAG;AAAA,IACA,SAAAF;AAAA,IACA,OAAAG;AAAA,IACA,UAAAC;AAAA,IACA,UAAAC;AAAA,EAAA;AAEJ;"}
1
+ {"version":3,"file":"useTimer.mjs","sources":["../../../../src/hooks/useTimer/useTimer.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport { useDidUpdate } from '../useDidUpdate/useDidUpdate';\n\nexport type PositiveInteger<Value extends number> = `${Value}` extends `-${any}` | `${any}.${any}`\n ? never\n : Value;\n\nexport const getTimeFromSeconds = (timestamp: number) => {\n const roundedTimestamp = Math.ceil(timestamp);\n const days = Math.floor(roundedTimestamp / (60 * 60 * 24));\n const hours = Math.floor((roundedTimestamp % (60 * 60 * 24)) / (60 * 60));\n const minutes = Math.floor((roundedTimestamp % (60 * 60)) / 60);\n const seconds = Math.floor(roundedTimestamp % 60);\n\n return {\n seconds,\n minutes,\n hours,\n days\n };\n};\n\n/** The use timer options type */\nexport interface UseTimerOptions {\n /** Whether the timer should start automatically */\n immediately?: boolean;\n /** The function to be executed when the timer is expired */\n onExpire?: () => void;\n /** The function to be executed when the timer is started */\n onStart?: () => void;\n /** Callback function to be executed on each tick of the timer */\n onTick?: (seconds: number) => void;\n}\n\n/** The use timer return type */\nexport interface UseTimerReturn {\n /** flag to indicate if timer is active or not */\n active: boolean;\n /** The total count of the timer */\n count: number;\n /** The day count of the timer */\n days: number;\n /** The hour count of the timer */\n hours: number;\n /** The minute count of the timer */\n minutes: number;\n /** The second count of the timer */\n seconds: number;\n /** The function to clear the timer */\n clear: () => void;\n /** The function to decrease the timer */\n decrease: (seconds: PositiveInteger<number>) => void;\n /** The function to increase the timer */\n increase: (seconds: PositiveInteger<number>) => void;\n /** The function to pause the timer */\n pause: () => void;\n /** The function to restart the timer */\n restart: (time: PositiveInteger<number>, immediately?: boolean) => void;\n /** The function to resume the timer */\n resume: () => void;\n /** The function to start the timer */\n start: () => void;\n /** The function to toggle the timer */\n toggle: () => void;\n}\n\nexport interface UseTimer {\n (): UseTimerReturn;\n\n (seconds: PositiveInteger<number>, callback: () => void): UseTimerReturn;\n\n (seconds: PositiveInteger<number>, options?: UseTimerOptions): UseTimerReturn;\n}\n\n/**\n * @name useTimer\n * @description - Hook that creates a timer functionality\n * @category Time\n * @usage medium\n *\n * @overload\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer();\n *\n * @overload\n * @param {number} seconds The seconds value that define for how long the timer will be running\n * @param {() => void} callback The function to be executed once countdown timer is expired\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer(1000, () => console.log('ready'));\n *\n * @overload\n * @param {number} seconds The seconds value that define for how long the timer will be running\n * @param {boolean} [options.immediately=true] The flag to decide if timer should start automatically\n * @param {() => void} [options.onExpire] The function to be executed when the timer is expired\n * @param {(timestamp: number) => void} [options.onTick] The function to be executed on each tick of the timer\n * @returns {UseTimerReturn} An object containing the timer properties and functions\n *\n * @example\n * const { days, hours, minutes, seconds, toggle, pause, start, restart, resume, active, decrease, increase } = useTimer(1000);\n */\nexport const useTimer = ((...params: any[]) => {\n const initialSeconds = Math.max((params[0] ?? 0) as PositiveInteger<number>, 0);\n const options = (typeof params[1] === 'object' ? params[1] : { onExpire: params[1] }) as\n | UseTimerOptions\n | undefined;\n\n const [active, setActive] = useState(initialSeconds > 0 && (options?.immediately ?? true));\n const [seconds, setSeconds] = useState(initialSeconds);\n\n const intervalIdRef = useRef<ReturnType<typeof setInterval>>(undefined);\n const optionsRef = useRef<UseTimerOptions>(options);\n optionsRef.current = options ?? {};\n\n useDidUpdate(() => {\n if (initialSeconds <= 0) {\n setActive(false);\n setSeconds(0);\n return;\n }\n\n setActive(true);\n setSeconds(initialSeconds);\n }, [initialSeconds]);\n\n useEffect(() => {\n if (!active) return;\n\n optionsRef.current?.onStart?.();\n const onInterval = () => {\n setSeconds((prevSeconds) => {\n optionsRef.current?.onTick?.(prevSeconds);\n const updatedSeconds = prevSeconds - 1;\n if (updatedSeconds === 0) {\n setActive(false);\n optionsRef.current?.onExpire?.();\n }\n return updatedSeconds;\n });\n };\n\n intervalIdRef.current = setInterval(onInterval, 1000);\n return () => {\n clearInterval(intervalIdRef.current);\n };\n }, [active]);\n\n const pause = () => setActive(false);\n const resume = () => {\n if (seconds <= 0) return;\n setActive(true);\n };\n\n const toggle = () => {\n if (seconds <= 0) return;\n setActive(!active);\n };\n\n const restart = (seconds: PositiveInteger<number>, immediately = true) => {\n setSeconds(seconds);\n if (immediately) setActive(true);\n };\n\n const start = () => {\n if (initialSeconds <= 0) return;\n\n setActive(true);\n setSeconds(initialSeconds);\n };\n\n const clear = () => {\n setActive(false);\n setSeconds(0);\n };\n\n const increase = (seconds: PositiveInteger<number>) =>\n setSeconds((prevSeconds) => prevSeconds + seconds);\n const decrease = (seconds: PositiveInteger<number>) => {\n setSeconds((prevSeconds) => {\n const updatedSeconds = prevSeconds - seconds;\n if (updatedSeconds <= 0) {\n setActive(false);\n return 0;\n } else {\n return updatedSeconds;\n }\n });\n };\n\n return {\n ...getTimeFromSeconds(seconds),\n count: seconds,\n pause,\n active,\n resume,\n toggle,\n start,\n restart,\n clear,\n increase,\n decrease\n };\n}) as UseTimer;\n"],"names":["getTimeFromSeconds","timestamp","roundedTimestamp","days","hours","minutes","useTimer","params","initialSeconds","options","active","setActive","useState","seconds","setSeconds","intervalIdRef","useRef","optionsRef","useDidUpdate","useEffect","onInterval","prevSeconds","updatedSeconds","pause","resume","toggle","restart","immediately","start","clear","increase","decrease"],"mappings":";;AAQO,MAAMA,IAAqB,CAACC,MAAsB;AACvD,QAAMC,IAAmB,KAAK,KAAKD,CAAS,GACtCE,IAAO,KAAK,MAAMD,KAAoB,OAAU,GAAG,GACnDE,IAAQ,KAAK,MAAOF,KAAoB,OAAU,MAAQ,IAAQ,GAClEG,IAAU,KAAK,MAAOH,IAAoB,OAAY,EAAE;AAG9D,SAAO;AAAA,IACL,SAHc,KAAK,MAAMA,IAAmB,EAAE;AAAA,IAI9C,SAAAG;AAAA,IACA,OAAAD;AAAA,IACA,MAAAD;AAAA,EAAA;AAEJ,GAoFaG,KAAY,IAAIC,MAAkB;AAC7C,QAAMC,IAAiB,KAAK,IAAKD,EAAO,CAAC,KAAK,GAA+B,CAAC,GACxEE,IAAW,OAAOF,EAAO,CAAC,KAAM,WAAWA,EAAO,CAAC,IAAI,EAAE,UAAUA,EAAO,CAAC,EAAA,GAI3E,CAACG,GAAQC,CAAS,IAAIC,EAASJ,IAAiB,MAAMC,GAAS,eAAe,GAAK,GACnF,CAACI,GAASC,CAAU,IAAIF,EAASJ,CAAc,GAE/CO,IAAgBC,EAAuC,MAAS,GAChEC,IAAaD,EAAwBP,CAAO;AAClD,EAAAQ,EAAW,UAAUR,KAAW,CAAA,GAEhCS,EAAa,MAAM;AACjB,QAAIV,KAAkB,GAAG;AACvB,MAAAG,EAAU,EAAK,GACfG,EAAW,CAAC;AACZ;AAAA,IAAA;AAGF,IAAAH,EAAU,EAAI,GACdG,EAAWN,CAAc;AAAA,EAAA,GACxB,CAACA,CAAc,CAAC,GAEnBW,EAAU,MAAM;AACd,QAAI,CAACT,EAAQ;AAEb,IAAAO,EAAW,SAAS,UAAA;AACpB,UAAMG,IAAa,MAAM;AACvB,MAAAN,EAAW,CAACO,MAAgB;AAC1B,QAAAJ,EAAW,SAAS,SAASI,CAAW;AACxC,cAAMC,IAAiBD,IAAc;AACrC,eAAIC,MAAmB,MACrBX,EAAU,EAAK,GACfM,EAAW,SAAS,WAAA,IAEfK;AAAA,MAAA,CACR;AAAA,IAAA;AAGH,WAAAP,EAAc,UAAU,YAAYK,GAAY,GAAI,GAC7C,MAAM;AACX,oBAAcL,EAAc,OAAO;AAAA,IAAA;AAAA,EACrC,GACC,CAACL,CAAM,CAAC;AAEX,QAAMa,IAAQ,MAAMZ,EAAU,EAAK,GAC7Ba,IAAS,MAAM;AACnB,IAAIX,KAAW,KACfF,EAAU,EAAI;AAAA,EAAA,GAGVc,IAAS,MAAM;AACnB,IAAIZ,KAAW,KACfF,EAAU,CAACD,CAAM;AAAA,EAAA,GAGbgB,IAAU,CAACb,GAAkCc,IAAc,OAAS;AACxE,IAAAb,EAAWD,CAAO,GACdc,OAAuB,EAAI;AAAA,EAAA,GAG3BC,IAAQ,MAAM;AAClB,IAAIpB,KAAkB,MAEtBG,EAAU,EAAI,GACdG,EAAWN,CAAc;AAAA,EAAA,GAGrBqB,IAAQ,MAAM;AAClB,IAAAlB,EAAU,EAAK,GACfG,EAAW,CAAC;AAAA,EAAA,GAGRgB,IAAW,CAACjB,MAChBC,EAAW,CAACO,MAAgBA,IAAcR,CAAO,GAC7CkB,IAAW,CAAClB,MAAqC;AACrD,IAAAC,EAAW,CAACO,MAAgB;AAC1B,YAAMC,IAAiBD,IAAcR;AACrC,aAAIS,KAAkB,KACpBX,EAAU,EAAK,GACR,KAEAW;AAAA,IACT,CACD;AAAA,EAAA;AAGH,SAAO;AAAA,IACL,GAAGtB,EAAmBa,CAAO;AAAA,IAC7B,OAAOA;AAAA,IACP,OAAAU;AAAA,IACA,QAAAb;AAAA,IACA,QAAAc;AAAA,IACA,QAAAC;AAAA,IACA,OAAAG;AAAA,IACA,SAAAF;AAAA,IACA,OAAAG;AAAA,IACA,UAAAC;AAAA,IACA,UAAAC;AAAA,EAAA;AAEJ;"}
@@ -17,7 +17,7 @@ const f = "reactuse-url-search-params-event", w = (n = "history") => {
17
17
  return `${s}${h}${r ? `?${r}` : ""}`;
18
18
  }
19
19
  throw new Error("Invalid mode");
20
- }, L = () => window.dispatchEvent(new Event(f)), U = (n, i) => {
20
+ }, L = () => window.dispatchEvent(new Event(f)), U = ((n, i) => {
21
21
  const r = typeof i == "object" && i && ("serializer" in i || "deserializer" in i || "initialValue" in i || "mode" in i || "write" in i) ? i : void 0, s = r ? r?.initialValue : i, { mode: t = "history", write: a = "replace" } = r ?? {};
22
22
  if (typeof window > "u")
23
23
  return {
@@ -66,7 +66,7 @@ const f = "reactuse-url-search-params-event", w = (n = "history") => {
66
66
  remove: g,
67
67
  set: P
68
68
  };
69
- };
69
+ });
70
70
  export {
71
71
  f as URL_SEARCH_PARAMS_EVENT,
72
72
  z as createQueryString,
@@ -1 +1 @@
1
- {"version":3,"file":"useUrlSearchParam.mjs","sources":["../../../../src/hooks/useUrlSearchParam/useUrlSearchParam.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\n/** The url search params mode type */\nexport type UrlSearchParamMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search param options type */\nexport interface UseUrlSearchParamOptions<Value> {\n /** The initial value of the search param */\n initialValue?: Value;\n /** The mode to use for writing to the URL */\n mode?: UrlSearchParamMode;\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n /** The deserializer function to be invoked */\n deserializer?: (value: string) => Value;\n /** The serializer function to be invoked */\n serializer?: (value: Value) => string;\n}\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsActionOptions {\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n}\n\n/** The use url search param return type */\nexport interface UseUrlSearchParamReturn<Value> {\n /** Current search param value */\n value: Value | undefined;\n /** Function to remove the search param */\n remove: (options?: UseUrlSearchParamsActionOptions) => void;\n /** Function to update search param */\n set: (value: Value, options?: UseUrlSearchParamsActionOptions) => void;\n}\n\nexport const URL_SEARCH_PARAMS_EVENT = 'reactuse-url-search-params-event';\n\nexport const getUrlSearchParams = (mode: UrlSearchParamMode = 'history') => {\n const { search, hash } = window.location;\n\n let path = '';\n\n if (mode === 'history') path = search;\n if (mode === 'hash-params') path = hash.replace(/^#/, '');\n if (mode === 'hash') {\n const index = hash.indexOf('?');\n path = ~index ? hash.slice(index) : '';\n }\n\n return new URLSearchParams(path);\n};\n\nexport const createQueryString = (searchParams: URLSearchParams, mode: UrlSearchParamMode) => {\n const searchParamsString = searchParams.toString();\n const { search, hash } = window.location;\n\n if (mode === 'history') return `${searchParamsString ? `?${searchParamsString}` : ''}${hash}`;\n if (mode === 'hash-params')\n return `${search}${searchParamsString ? `#${searchParamsString}` : ''}`;\n if (mode === 'hash') {\n const index = hash.indexOf('?');\n const base = index > -1 ? hash.slice(0, index) : hash;\n return `${search}${base}${searchParamsString ? `?${searchParamsString}` : ''}`;\n }\n\n throw new Error('Invalid mode');\n};\n\nexport const dispatchUrlSearchParamsEvent = () =>\n window.dispatchEvent(new Event(URL_SEARCH_PARAMS_EVENT));\n\nexport interface UseUrlSearchParam {\n <Value>(\n key: string,\n options: UseUrlSearchParamOptions<Value> & { initialValue: Value }\n ): UseUrlSearchParamReturn<Value>;\n\n <Value>(\n key: string,\n options?: UseUrlSearchParamOptions<Value>\n ): UseUrlSearchParamReturn<Value | undefined>;\n\n <Value>(key: string, initialValue: Value): UseUrlSearchParamReturn<Value>;\n\n <Value>(key: string): UseUrlSearchParamReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParam\n * @description - Hook that provides reactive URLSearchParams for a single key\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {string} key The key of the url param\n * @param {UseUrlSearchParamOptions<Value> & { initialValue: Value }} options The options object with required initialValue\n * @param {Value} options.initialValue The initial value for the url param\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParam('page', { initialValue: 1 });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {string} key The key of the url param\n * @param {Value} [initialValue] The initial value for the url param\n * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParam('page', 1);\n */\nexport const useUrlSearchParam = (<Value>(key: string, params?: any) => {\n const options = (\n typeof params === 'object' &&\n params &&\n ('serializer' in params ||\n 'deserializer' in params ||\n 'initialValue' in params ||\n 'mode' in params ||\n 'write' in params)\n ? params\n : undefined\n ) as UseUrlSearchParamOptions<Value>;\n\n const initialValue = (options ? options?.initialValue : params) as Value;\n const { mode = 'history', write: writeMode = 'replace' } = options ?? {};\n\n if (typeof window === 'undefined') {\n return {\n value: initialValue,\n remove: () => {},\n set: () => {}\n } as UseUrlSearchParamReturn<Value>;\n }\n\n const serializer = (value: Value) => {\n if (options?.serializer) return options.serializer(value);\n if (typeof value === 'string') return value;\n\n return JSON.stringify(value);\n };\n\n const deserializer = (value: string) => {\n if (options?.deserializer) return options.deserializer(value);\n if (value === 'undefined' || value === 'null') return undefined as unknown as Value;\n\n try {\n return JSON.parse(value) as Value;\n } catch {\n return value as Value;\n }\n };\n\n const setUrlSearchParam = (\n key: string,\n value: Value | undefined,\n mode: UrlSearchParamMode,\n write: 'push' | 'replace' = 'replace'\n ) => {\n const urlSearchParams = getUrlSearchParams(mode);\n\n if (value === undefined) {\n urlSearchParams.delete(key);\n } else {\n const serializedValue = serializer ? serializer(value) : String(value);\n urlSearchParams.set(key, serializedValue);\n }\n\n const query = createQueryString(urlSearchParams, mode);\n if (write === 'replace') window.history.replaceState({}, '', query);\n if (write === 'push') window.history.pushState({}, '', query);\n\n dispatchUrlSearchParamsEvent();\n };\n\n const [value, setValue] = useState<Value | undefined>(() => {\n const urlSearchParams = getUrlSearchParams(mode);\n const currentValue = urlSearchParams.get(key);\n\n if (currentValue === null && initialValue !== undefined) {\n setUrlSearchParam(key, initialValue, mode, writeMode);\n return initialValue;\n }\n\n return currentValue ? deserializer(currentValue) : undefined;\n });\n\n const set = (value: Value, options?: UseUrlSearchParamsActionOptions) => {\n setUrlSearchParam(key, value, mode, options?.write ?? writeMode);\n setValue(value);\n };\n\n const remove = (options?: UseUrlSearchParamsActionOptions) => {\n setUrlSearchParam(key, undefined, mode, options?.write ?? writeMode);\n setValue(undefined);\n };\n\n useEffect(() => {\n const onParamsChange = () => {\n const urlSearchParams = getUrlSearchParams(mode);\n const newValue = urlSearchParams.get(key);\n setValue(newValue ? deserializer(newValue) : undefined);\n };\n\n window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.addEventListener('popstate', onParamsChange);\n if (mode !== 'history') {\n window.addEventListener('hashchange', onParamsChange);\n }\n\n return () => {\n window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.removeEventListener('popstate', onParamsChange);\n if (mode !== 'history') {\n window.removeEventListener('hashchange', onParamsChange);\n }\n };\n }, [key, mode]);\n\n return {\n value,\n remove,\n set\n };\n}) as UseUrlSearchParam;\n"],"names":["URL_SEARCH_PARAMS_EVENT","getUrlSearchParams","mode","search","hash","path","index","createQueryString","searchParams","searchParamsString","base","dispatchUrlSearchParamsEvent","useUrlSearchParam","key","params","options","initialValue","writeMode","serializer","value","deserializer","setUrlSearchParam","write","urlSearchParams","serializedValue","query","setValue","useState","currentValue","set","remove","useEffect","onParamsChange","newValue"],"mappings":";AAmCO,MAAMA,IAA0B,oCAE1BC,IAAqB,CAACC,IAA2B,cAAc;AAC1E,QAAM,EAAE,QAAAC,GAAQ,MAAAC,EAAA,IAAS,OAAO;AAEhC,MAAIC,IAAO;AAIX,MAFIH,MAAS,cAAWG,IAAOF,IAC3BD,MAAS,kBAAeG,IAAOD,EAAK,QAAQ,MAAM,EAAE,IACpDF,MAAS,QAAQ;AACnB,UAAMI,IAAQF,EAAK,QAAQ,GAAG;AAC9B,IAAAC,IAAO,CAACC,IAAQF,EAAK,MAAME,CAAK,IAAI;AAAA,EAAA;AAGtC,SAAO,IAAI,gBAAgBD,CAAI;AACjC,GAEaE,IAAoB,CAACC,GAA+BN,MAA6B;AAC5F,QAAMO,IAAqBD,EAAa,SAAA,GAClC,EAAE,QAAAL,GAAQ,MAAAC,EAAA,IAAS,OAAO;AAEhC,MAAIF,MAAS,UAAW,QAAO,GAAGO,IAAqB,IAAIA,CAAkB,KAAK,EAAE,GAAGL,CAAI;AAC3F,MAAIF,MAAS;AACX,WAAO,GAAGC,CAAM,GAAGM,IAAqB,IAAIA,CAAkB,KAAK,EAAE;AACvE,MAAIP,MAAS,QAAQ;AACnB,UAAMI,IAAQF,EAAK,QAAQ,GAAG,GACxBM,IAAOJ,IAAQ,KAAKF,EAAK,MAAM,GAAGE,CAAK,IAAIF;AACjD,WAAO,GAAGD,CAAM,GAAGO,CAAI,GAAGD,IAAqB,IAAIA,CAAkB,KAAK,EAAE;AAAA,EAAA;AAG9E,QAAM,IAAI,MAAM,cAAc;AAChC,GAEaE,IAA+B,MAC1C,OAAO,cAAc,IAAI,MAAMX,CAAuB,CAAC,GA+C5CY,IAAqB,CAAQC,GAAaC,MAAiB;AACtE,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,QAGAE,IAAgBD,IAAUA,GAAS,eAAeD,GAClD,EAAE,MAAAZ,IAAO,WAAW,OAAOe,IAAY,UAAA,IAAcF,KAAW,CAAA;AAEtE,MAAI,OAAO,SAAW;AACpB,WAAO;AAAA,MACL,OAAOC;AAAA,MACP,QAAQ,MAAM;AAAA,MAAA;AAAA,MACd,KAAK,MAAM;AAAA,MAAA;AAAA,IAAC;AAIhB,QAAME,IAAa,CAACC,MACdJ,GAAS,aAAmBA,EAAQ,WAAWI,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAE/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIJ,GAAS,aAAc,QAAOA,EAAQ,aAAaI,CAAK;AAC5D,QAAIA,EAAAA,MAAU,eAAeA,MAAU;AAEvC,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAoB,CACxBR,GACAM,GACAjB,GACAoB,IAA4B,cACzB;AACH,UAAMC,IAAkBtB,EAAmBC,CAAI;AAE/C,QAAIiB,MAAU;AACZ,MAAAI,EAAgB,OAAOV,CAAG;AAAA,SACrB;AACL,YAAMW,IAAkBN,IAAaA,EAAWC,CAAK,IAAI,OAAOA,CAAK;AACrE,MAAAI,EAAgB,IAAIV,GAAKW,CAAe;AAAA,IAAA;AAG1C,UAAMC,IAAQlB,EAAkBgB,GAAiBrB,CAAI;AACrD,IAAIoB,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIG,CAAK,GAC9DH,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIG,CAAK,GAE5Dd,EAAA;AAAA,EAA6B,GAGzB,CAACQ,GAAOO,CAAQ,IAAIC,EAA4B,MAAM;AAE1D,UAAMC,IADkB3B,EAAmBC,CAAI,EACV,IAAIW,CAAG;AAE5C,WAAIe,MAAiB,QAAQZ,MAAiB,UAC5CK,EAAkBR,GAAKG,GAAcd,GAAMe,CAAS,GAC7CD,KAGFY,IAAeR,EAAaQ,CAAY,IAAI;AAAA,EAAA,CACpD,GAEKC,IAAM,CAACV,GAAcJ,MAA8C;AACvE,IAAAM,EAAkBR,GAAKM,GAAOjB,GAAMa,GAAS,SAASE,CAAS,GAC/DS,EAASP,CAAK;AAAA,EAAA,GAGVW,IAAS,CAACf,MAA8C;AAC5D,IAAAM,EAAkBR,GAAK,QAAWX,GAAMa,GAAS,SAASE,CAAS,GACnES,EAAS,MAAS;AAAA,EAAA;AAGpB,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAE3B,YAAMC,IADkBhC,EAAmBC,CAAI,EACd,IAAIW,CAAG;AACxC,MAAAa,EAASO,IAAWb,EAAaa,CAAQ,IAAI,MAAS;AAAA,IAAA;AAGxD,kBAAO,iBAAiBjC,GAAyBgC,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9C9B,MAAS,aACX,OAAO,iBAAiB,cAAc8B,CAAc,GAG/C,MAAM;AACX,aAAO,oBAAoBhC,GAAyBgC,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjD9B,MAAS,aACX,OAAO,oBAAoB,cAAc8B,CAAc;AAAA,IACzD;AAAA,EACF,GACC,CAACnB,GAAKX,CAAI,CAAC,GAEP;AAAA,IACL,OAAAiB;AAAA,IACA,QAAAW;AAAA,IACA,KAAAD;AAAA,EAAA;AAEJ;"}
1
+ {"version":3,"file":"useUrlSearchParam.mjs","sources":["../../../../src/hooks/useUrlSearchParam/useUrlSearchParam.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\n/** The url search params mode type */\nexport type UrlSearchParamMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search param options type */\nexport interface UseUrlSearchParamOptions<Value> {\n /** The initial value of the search param */\n initialValue?: Value;\n /** The mode to use for writing to the URL */\n mode?: UrlSearchParamMode;\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n /** The deserializer function to be invoked */\n deserializer?: (value: string) => Value;\n /** The serializer function to be invoked */\n serializer?: (value: Value) => string;\n}\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsActionOptions {\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n}\n\n/** The use url search param return type */\nexport interface UseUrlSearchParamReturn<Value> {\n /** Current search param value */\n value: Value | undefined;\n /** Function to remove the search param */\n remove: (options?: UseUrlSearchParamsActionOptions) => void;\n /** Function to update search param */\n set: (value: Value, options?: UseUrlSearchParamsActionOptions) => void;\n}\n\nexport const URL_SEARCH_PARAMS_EVENT = 'reactuse-url-search-params-event';\n\nexport const getUrlSearchParams = (mode: UrlSearchParamMode = 'history') => {\n const { search, hash } = window.location;\n\n let path = '';\n\n if (mode === 'history') path = search;\n if (mode === 'hash-params') path = hash.replace(/^#/, '');\n if (mode === 'hash') {\n const index = hash.indexOf('?');\n path = ~index ? hash.slice(index) : '';\n }\n\n return new URLSearchParams(path);\n};\n\nexport const createQueryString = (searchParams: URLSearchParams, mode: UrlSearchParamMode) => {\n const searchParamsString = searchParams.toString();\n const { search, hash } = window.location;\n\n if (mode === 'history') return `${searchParamsString ? `?${searchParamsString}` : ''}${hash}`;\n if (mode === 'hash-params')\n return `${search}${searchParamsString ? `#${searchParamsString}` : ''}`;\n if (mode === 'hash') {\n const index = hash.indexOf('?');\n const base = index > -1 ? hash.slice(0, index) : hash;\n return `${search}${base}${searchParamsString ? `?${searchParamsString}` : ''}`;\n }\n\n throw new Error('Invalid mode');\n};\n\nexport const dispatchUrlSearchParamsEvent = () =>\n window.dispatchEvent(new Event(URL_SEARCH_PARAMS_EVENT));\n\nexport interface UseUrlSearchParam {\n <Value>(\n key: string,\n options: UseUrlSearchParamOptions<Value> & { initialValue: Value }\n ): UseUrlSearchParamReturn<Value>;\n\n <Value>(\n key: string,\n options?: UseUrlSearchParamOptions<Value>\n ): UseUrlSearchParamReturn<Value | undefined>;\n\n <Value>(key: string, initialValue: Value): UseUrlSearchParamReturn<Value>;\n\n <Value>(key: string): UseUrlSearchParamReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParam\n * @description - Hook that provides reactive URLSearchParams for a single key\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {string} key The key of the url param\n * @param {UseUrlSearchParamOptions<Value> & { initialValue: Value }} options The options object with required initialValue\n * @param {Value} options.initialValue The initial value for the url param\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParam('page', { initialValue: 1 });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {string} key The key of the url param\n * @param {Value} [initialValue] The initial value for the url param\n * @returns {UseUrlSearchParamReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParam('page', 1);\n */\nexport const useUrlSearchParam = (<Value>(key: string, params?: any) => {\n const options = (\n typeof params === 'object' &&\n params &&\n ('serializer' in params ||\n 'deserializer' in params ||\n 'initialValue' in params ||\n 'mode' in params ||\n 'write' in params)\n ? params\n : undefined\n ) as UseUrlSearchParamOptions<Value>;\n\n const initialValue = (options ? options?.initialValue : params) as Value;\n const { mode = 'history', write: writeMode = 'replace' } = options ?? {};\n\n if (typeof window === 'undefined') {\n return {\n value: initialValue,\n remove: () => {},\n set: () => {}\n } as UseUrlSearchParamReturn<Value>;\n }\n\n const serializer = (value: Value) => {\n if (options?.serializer) return options.serializer(value);\n if (typeof value === 'string') return value;\n\n return JSON.stringify(value);\n };\n\n const deserializer = (value: string) => {\n if (options?.deserializer) return options.deserializer(value);\n if (value === 'undefined' || value === 'null') return undefined as unknown as Value;\n\n try {\n return JSON.parse(value) as Value;\n } catch {\n return value as Value;\n }\n };\n\n const setUrlSearchParam = (\n key: string,\n value: Value | undefined,\n mode: UrlSearchParamMode,\n write: 'push' | 'replace' = 'replace'\n ) => {\n const urlSearchParams = getUrlSearchParams(mode);\n\n if (value === undefined) {\n urlSearchParams.delete(key);\n } else {\n const serializedValue = serializer ? serializer(value) : String(value);\n urlSearchParams.set(key, serializedValue);\n }\n\n const query = createQueryString(urlSearchParams, mode);\n if (write === 'replace') window.history.replaceState({}, '', query);\n if (write === 'push') window.history.pushState({}, '', query);\n\n dispatchUrlSearchParamsEvent();\n };\n\n const [value, setValue] = useState<Value | undefined>(() => {\n const urlSearchParams = getUrlSearchParams(mode);\n const currentValue = urlSearchParams.get(key);\n\n if (currentValue === null && initialValue !== undefined) {\n setUrlSearchParam(key, initialValue, mode, writeMode);\n return initialValue;\n }\n\n return currentValue ? deserializer(currentValue) : undefined;\n });\n\n const set = (value: Value, options?: UseUrlSearchParamsActionOptions) => {\n setUrlSearchParam(key, value, mode, options?.write ?? writeMode);\n setValue(value);\n };\n\n const remove = (options?: UseUrlSearchParamsActionOptions) => {\n setUrlSearchParam(key, undefined, mode, options?.write ?? writeMode);\n setValue(undefined);\n };\n\n useEffect(() => {\n const onParamsChange = () => {\n const urlSearchParams = getUrlSearchParams(mode);\n const newValue = urlSearchParams.get(key);\n setValue(newValue ? deserializer(newValue) : undefined);\n };\n\n window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.addEventListener('popstate', onParamsChange);\n if (mode !== 'history') {\n window.addEventListener('hashchange', onParamsChange);\n }\n\n return () => {\n window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.removeEventListener('popstate', onParamsChange);\n if (mode !== 'history') {\n window.removeEventListener('hashchange', onParamsChange);\n }\n };\n }, [key, mode]);\n\n return {\n value,\n remove,\n set\n };\n}) as UseUrlSearchParam;\n"],"names":["URL_SEARCH_PARAMS_EVENT","getUrlSearchParams","mode","search","hash","path","index","createQueryString","searchParams","searchParamsString","base","dispatchUrlSearchParamsEvent","useUrlSearchParam","key","params","options","initialValue","writeMode","serializer","value","deserializer","setUrlSearchParam","write","urlSearchParams","serializedValue","query","setValue","useState","currentValue","set","remove","useEffect","onParamsChange","newValue"],"mappings":";AAmCO,MAAMA,IAA0B,oCAE1BC,IAAqB,CAACC,IAA2B,cAAc;AAC1E,QAAM,EAAE,QAAAC,GAAQ,MAAAC,EAAA,IAAS,OAAO;AAEhC,MAAIC,IAAO;AAIX,MAFIH,MAAS,cAAWG,IAAOF,IAC3BD,MAAS,kBAAeG,IAAOD,EAAK,QAAQ,MAAM,EAAE,IACpDF,MAAS,QAAQ;AACnB,UAAMI,IAAQF,EAAK,QAAQ,GAAG;AAC9B,IAAAC,IAAO,CAACC,IAAQF,EAAK,MAAME,CAAK,IAAI;AAAA,EAAA;AAGtC,SAAO,IAAI,gBAAgBD,CAAI;AACjC,GAEaE,IAAoB,CAACC,GAA+BN,MAA6B;AAC5F,QAAMO,IAAqBD,EAAa,SAAA,GAClC,EAAE,QAAAL,GAAQ,MAAAC,EAAA,IAAS,OAAO;AAEhC,MAAIF,MAAS,UAAW,QAAO,GAAGO,IAAqB,IAAIA,CAAkB,KAAK,EAAE,GAAGL,CAAI;AAC3F,MAAIF,MAAS;AACX,WAAO,GAAGC,CAAM,GAAGM,IAAqB,IAAIA,CAAkB,KAAK,EAAE;AACvE,MAAIP,MAAS,QAAQ;AACnB,UAAMI,IAAQF,EAAK,QAAQ,GAAG,GACxBM,IAAOJ,IAAQ,KAAKF,EAAK,MAAM,GAAGE,CAAK,IAAIF;AACjD,WAAO,GAAGD,CAAM,GAAGO,CAAI,GAAGD,IAAqB,IAAIA,CAAkB,KAAK,EAAE;AAAA,EAAA;AAG9E,QAAM,IAAI,MAAM,cAAc;AAChC,GAEaE,IAA+B,MAC1C,OAAO,cAAc,IAAI,MAAMX,CAAuB,CAAC,GA+C5CY,KAAqB,CAAQC,GAAaC,MAAiB;AACtE,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,QAGAE,IAAgBD,IAAUA,GAAS,eAAeD,GAClD,EAAE,MAAAZ,IAAO,WAAW,OAAOe,IAAY,UAAA,IAAcF,KAAW,CAAA;AAEtE,MAAI,OAAO,SAAW;AACpB,WAAO;AAAA,MACL,OAAOC;AAAA,MACP,QAAQ,MAAM;AAAA,MAAA;AAAA,MACd,KAAK,MAAM;AAAA,MAAA;AAAA,IAAC;AAIhB,QAAME,IAAa,CAACC,MACdJ,GAAS,aAAmBA,EAAQ,WAAWI,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAE/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIJ,GAAS,aAAc,QAAOA,EAAQ,aAAaI,CAAK;AAC5D,QAAIA,EAAAA,MAAU,eAAeA,MAAU;AAEvC,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAoB,CACxBR,GACAM,GACAjB,GACAoB,IAA4B,cACzB;AACH,UAAMC,IAAkBtB,EAAmBC,CAAI;AAE/C,QAAIiB,MAAU;AACZ,MAAAI,EAAgB,OAAOV,CAAG;AAAA,SACrB;AACL,YAAMW,IAAkBN,IAAaA,EAAWC,CAAK,IAAI,OAAOA,CAAK;AACrE,MAAAI,EAAgB,IAAIV,GAAKW,CAAe;AAAA,IAAA;AAG1C,UAAMC,IAAQlB,EAAkBgB,GAAiBrB,CAAI;AACrD,IAAIoB,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIG,CAAK,GAC9DH,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIG,CAAK,GAE5Dd,EAAA;AAAA,EAA6B,GAGzB,CAACQ,GAAOO,CAAQ,IAAIC,EAA4B,MAAM;AAE1D,UAAMC,IADkB3B,EAAmBC,CAAI,EACV,IAAIW,CAAG;AAE5C,WAAIe,MAAiB,QAAQZ,MAAiB,UAC5CK,EAAkBR,GAAKG,GAAcd,GAAMe,CAAS,GAC7CD,KAGFY,IAAeR,EAAaQ,CAAY,IAAI;AAAA,EAAA,CACpD,GAEKC,IAAM,CAACV,GAAcJ,MAA8C;AACvE,IAAAM,EAAkBR,GAAKM,GAAOjB,GAAMa,GAAS,SAASE,CAAS,GAC/DS,EAASP,CAAK;AAAA,EAAA,GAGVW,IAAS,CAACf,MAA8C;AAC5D,IAAAM,EAAkBR,GAAK,QAAWX,GAAMa,GAAS,SAASE,CAAS,GACnES,EAAS,MAAS;AAAA,EAAA;AAGpB,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAE3B,YAAMC,IADkBhC,EAAmBC,CAAI,EACd,IAAIW,CAAG;AACxC,MAAAa,EAASO,IAAWb,EAAaa,CAAQ,IAAI,MAAS;AAAA,IAAA;AAGxD,kBAAO,iBAAiBjC,GAAyBgC,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9C9B,MAAS,aACX,OAAO,iBAAiB,cAAc8B,CAAc,GAG/C,MAAM;AACX,aAAO,oBAAoBhC,GAAyBgC,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjD9B,MAAS,aACX,OAAO,oBAAoB,cAAc8B,CAAc;AAAA,IACzD;AAAA,EACF,GACC,CAACnB,GAAKX,CAAI,CAAC,GAEP;AAAA,IACL,OAAAiB;AAAA,IACA,QAAAW;AAAA,IACA,KAAAD;AAAA,EAAA;AAEJ;"}
@@ -1,6 +1,6 @@
1
1
  import { useState as L, useEffect as v } from "react";
2
2
  import { getUrlSearchParams as u, URL_SEARCH_PARAMS_EVENT as g, createQueryString as U, dispatchUrlSearchParamsEvent as m } from "../useUrlSearchParam/useUrlSearchParam.mjs";
3
- const A = (t) => {
3
+ const A = ((t) => {
4
4
  const i = typeof t == "object" && t && ("serializer" in t || "deserializer" in t || "initialValue" in t || "mode" in t || "write" in t) ? t : {}, c = i ? i?.initialValue : t, { mode: n = "history", write: f = "replace" } = i, l = (e) => i?.serializer ? i.serializer(e) : typeof e == "string" ? e : JSON.stringify(e), p = (e) => {
5
5
  if (i?.deserializer) return i.deserializer(e);
6
6
  if (e !== "undefined")
@@ -51,7 +51,7 @@ const A = (t) => {
51
51
  value: w,
52
52
  set: P
53
53
  };
54
- };
54
+ });
55
55
  export {
56
56
  U as createQueryString,
57
57
  m as dispatchUrlSearchParamsEvent,
@@ -1 +1 @@
1
- {"version":3,"file":"useUrlSearchParams.mjs","sources":["../../../../src/hooks/useUrlSearchParams/useUrlSearchParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n createQueryString,\n dispatchUrlSearchParamsEvent,\n getUrlSearchParams,\n URL_SEARCH_PARAMS_EVENT\n} from '../useUrlSearchParam/useUrlSearchParam';\n\n/** The url params type */\nexport type UrlParams = Record<string, any>;\n\n/** The url search params mod */\nexport type UrlSearchParamsMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsSetOptions {\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n}\n\n/* The use search params initial value type */\nexport type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;\n\n/** The use url search params options type */\nexport interface UseUrlSearchParamsOptions<Value> {\n /* The initial value of the url search params */\n initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;\n /** The mode to use for writing to the URL */\n mode?: UrlSearchParamsMode;\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n /* The deserializer function to be invoked */\n deserializer?: (value: string) => Value[keyof Value];\n /* The serializer function to be invoked */\n serializer?: (value: Value[keyof Value]) => string;\n}\n\n/** The use url search params return type */\nexport interface UseUrlSearchParamsReturn<Value> {\n /** The value of the url search params */\n value: Value;\n /** The set function */\n set: (value: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => void;\n}\n\nexport interface UseUrlSearchParams {\n <Value>(\n key: string,\n options: UseUrlSearchParamsOptions<Value> & {\n initialValue: UseUrlSearchParamsInitialValue<Value>;\n }\n ): UseUrlSearchParamsReturn<Value>;\n\n <Value>(options?: UseUrlSearchParamsOptions<Value>): UseUrlSearchParamsReturn<Value | undefined>;\n\n <Value>(initialValue: UseUrlSearchParamsInitialValue<Value>): UseUrlSearchParamsReturn<Value>;\n\n <Value>(key: string): UseUrlSearchParamsReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParams\n * @description - Hook that provides reactive URLSearchParams\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsOptions<Value> & { initialValue: UseUrlSearchParamsInitialValue<Value> }} options The options object with required initialValue\n * @param {UseUrlSearchParamsInitialValue<Value>} [options.initialValue] The initial value for the url params\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value[keyof Value]) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value[keyof Value]} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ initialValue: { page: 1 } });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsInitialValue<Value>} [initialValue] The initial value for the url params\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ page: 1 });\n */\nexport const useUrlSearchParams = (<Value extends UrlParams>(\n params: any\n): UseUrlSearchParamsReturn<Value> => {\n const options = (\n typeof params === 'object' &&\n params &&\n ('serializer' in params ||\n 'deserializer' in params ||\n 'initialValue' in params ||\n 'mode' in params ||\n 'write' in params)\n ? params\n : {}\n ) as UseUrlSearchParamsOptions<Value>;\n const initialValue = (\n options ? options?.initialValue : params\n ) as UseUrlSearchParamsInitialValue<Value>;\n\n const { mode = 'history', write: writeMode = 'replace' } = options;\n\n const serializer = (value: Value[keyof Value]) => {\n if (options?.serializer) return options.serializer(value);\n if (typeof value === 'string') return value;\n return JSON.stringify(value);\n };\n\n const deserializer = (value: string) => {\n if (options?.deserializer) return options.deserializer(value);\n if (value === 'undefined') return undefined as unknown as Value[keyof Value];\n\n try {\n return JSON.parse(value) as Value;\n } catch {\n return value as Value[keyof Value];\n }\n };\n\n const setUrlSearchParams = <Value extends UrlParams>(\n mode: UrlSearchParamsMode,\n value: Partial<Value>,\n write: 'push' | 'replace' = 'replace'\n ) => {\n const urlSearchParams = getUrlSearchParams(mode);\n\n Object.entries(value).forEach(([key, param]) => {\n if (param === undefined) {\n urlSearchParams.delete(key);\n } else {\n const serializedValue = serializer ? serializer(param) : String(param);\n urlSearchParams.set(key, serializedValue);\n }\n });\n\n const query = createQueryString(urlSearchParams, mode);\n if (write === 'replace') window.history.replaceState({}, '', query);\n if (write === 'push') window.history.pushState({}, '', query);\n dispatchUrlSearchParamsEvent();\n\n return urlSearchParams;\n };\n\n const getParsedUrlSearchParams = (searchParams: string | UrlParams | URLSearchParams) => {\n if (typeof searchParams === 'string') {\n return getParsedUrlSearchParams(new URLSearchParams(searchParams));\n }\n\n if (searchParams instanceof URLSearchParams) {\n return Array.from(searchParams.entries()).reduce(\n (acc, [key, value]) => {\n acc[key] = deserializer(value);\n return acc;\n },\n {} as Record<string, any>\n );\n }\n\n return searchParams;\n };\n\n const [value, setValue] = useState<Value>(() => {\n if (typeof window === 'undefined') return (initialValue ?? {}) as Value;\n\n const urlSearchParams = getUrlSearchParams(mode);\n const value = {\n ...(initialValue && getParsedUrlSearchParams(initialValue)),\n ...getParsedUrlSearchParams(urlSearchParams)\n } as Value;\n\n setUrlSearchParams(mode, value, writeMode);\n\n return value;\n });\n\n const set = (params: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => {\n const searchParams = setUrlSearchParams(\n mode,\n { ...value, ...params },\n options?.write ?? writeMode\n );\n setValue(getParsedUrlSearchParams(searchParams) as Value);\n };\n\n useEffect(() => {\n const onParamsChange = () => {\n const searchParams = getUrlSearchParams(mode);\n setValue(getParsedUrlSearchParams(searchParams) as Value);\n };\n\n window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.addEventListener('popstate', onParamsChange);\n if (mode !== 'history') window.addEventListener('hashchange', onParamsChange);\n\n return () => {\n window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.removeEventListener('popstate', onParamsChange);\n if (mode !== 'history') window.removeEventListener('hashchange', onParamsChange);\n };\n }, [mode]);\n\n return {\n value,\n set\n };\n}) as UseUrlSearchParams;\n\nexport { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams };\n"],"names":["useUrlSearchParams","params","options","initialValue","mode","writeMode","serializer","value","deserializer","setUrlSearchParams","write","urlSearchParams","getUrlSearchParams","key","param","serializedValue","query","createQueryString","dispatchUrlSearchParamsEvent","getParsedUrlSearchParams","searchParams","acc","setValue","useState","set","useEffect","onParamsChange","URL_SEARCH_PARAMS_EVENT"],"mappings":";;AAwFO,MAAMA,IAAsB,CACjCC,MACoC;AACpC,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,CAAA,GAEAE,IACJD,IAAUA,GAAS,eAAeD,GAG9B,EAAE,MAAAG,IAAO,WAAW,OAAOC,IAAY,cAAcH,GAErDI,IAAa,CAACC,MACdL,GAAS,aAAmBA,EAAQ,WAAWK,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAC/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIL,GAAS,aAAc,QAAOA,EAAQ,aAAaK,CAAK;AAC5D,QAAIA,MAAU;AAEd,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAqB,CACzBL,GACAG,GACAG,IAA4B,cACzB;AACH,UAAMC,IAAkBC,EAAmBR,CAAI;AAE/C,WAAO,QAAQG,CAAK,EAAE,QAAQ,CAAC,CAACM,GAAKC,CAAK,MAAM;AAC9C,UAAIA,MAAU;AACZ,QAAAH,EAAgB,OAAOE,CAAG;AAAA,WACrB;AACL,cAAME,IAAkBT,IAAaA,EAAWQ,CAAK,IAAI,OAAOA,CAAK;AACrE,QAAAH,EAAgB,IAAIE,GAAKE,CAAe;AAAA,MAAA;AAAA,IAC1C,CACD;AAED,UAAMC,IAAQC,EAAkBN,GAAiBP,CAAI;AACrD,WAAIM,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIM,CAAK,GAC9DN,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIM,CAAK,GAC5DE,EAAA,GAEOP;AAAA,EAAA,GAGHQ,IAA2B,CAACC,MAC5B,OAAOA,KAAiB,WACnBD,EAAyB,IAAI,gBAAgBC,CAAY,CAAC,IAG/DA,aAAwB,kBACnB,MAAM,KAAKA,EAAa,QAAA,CAAS,EAAE;AAAA,IACxC,CAACC,GAAK,CAACR,GAAKN,CAAK,OACfc,EAAIR,CAAG,IAAIL,EAAaD,CAAK,GACtBc;AAAA,IAET,CAAA;AAAA,EAAC,IAIED,GAGH,CAACb,GAAOe,CAAQ,IAAIC,EAAgB,MAAM;AAC9C,QAAI,OAAO,SAAW,IAAa,QAAQpB,KAAgB,CAAA;AAE3D,UAAMQ,IAAkBC,EAAmBR,CAAI,GACzCG,IAAQ;AAAA,MACZ,GAAIJ,KAAgBgB,EAAyBhB,CAAY;AAAA,MACzD,GAAGgB,EAAyBR,CAAe;AAAA,IAAA;AAG7C,WAAAF,EAAmBL,GAAMG,GAAOF,CAAS,GAElCE;AAAAA,EAAA,CACR,GAEKiB,IAAM,CAACvB,GAAwBC,MAA2C;AAC9E,UAAMkB,IAAeX;AAAA,MACnBL;AAAA,MACA,EAAE,GAAGG,GAAO,GAAGN,EAAAA;AAAAA,MACfC,GAAS,SAASG;AAAA,IAAA;AAEpB,IAAAiB,EAASH,EAAyBC,CAAY,CAAU;AAAA,EAAA;AAG1D,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAC3B,YAAMN,IAAeR,EAAmBR,CAAI;AAC5C,MAAAkB,EAASH,EAAyBC,CAAY,CAAU;AAAA,IAAA;AAG1D,kBAAO,iBAAiBO,GAAyBD,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9CtB,MAAS,aAAW,OAAO,iBAAiB,cAAcsB,CAAc,GAErE,MAAM;AACX,aAAO,oBAAoBC,GAAyBD,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjDtB,MAAS,aAAW,OAAO,oBAAoB,cAAcsB,CAAc;AAAA,IAAA;AAAA,EACjF,GACC,CAACtB,CAAI,CAAC,GAEF;AAAA,IACL,OAAAG;AAAA,IACA,KAAAiB;AAAA,EAAA;AAEJ;"}
1
+ {"version":3,"file":"useUrlSearchParams.mjs","sources":["../../../../src/hooks/useUrlSearchParams/useUrlSearchParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n createQueryString,\n dispatchUrlSearchParamsEvent,\n getUrlSearchParams,\n URL_SEARCH_PARAMS_EVENT\n} from '../useUrlSearchParam/useUrlSearchParam';\n\n/** The url params type */\nexport type UrlParams = Record<string, any>;\n\n/** The url search params mod */\nexport type UrlSearchParamsMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsSetOptions {\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n}\n\n/* The use search params initial value type */\nexport type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;\n\n/** The use url search params options type */\nexport interface UseUrlSearchParamsOptions<Value> {\n /* The initial value of the url search params */\n initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;\n /** The mode to use for writing to the URL */\n mode?: UrlSearchParamsMode;\n /** The mode to use for writing to the URL */\n write?: 'push' | 'replace';\n /* The deserializer function to be invoked */\n deserializer?: (value: string) => Value[keyof Value];\n /* The serializer function to be invoked */\n serializer?: (value: Value[keyof Value]) => string;\n}\n\n/** The use url search params return type */\nexport interface UseUrlSearchParamsReturn<Value> {\n /** The value of the url search params */\n value: Value;\n /** The set function */\n set: (value: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => void;\n}\n\nexport interface UseUrlSearchParams {\n <Value>(\n key: string,\n options: UseUrlSearchParamsOptions<Value> & {\n initialValue: UseUrlSearchParamsInitialValue<Value>;\n }\n ): UseUrlSearchParamsReturn<Value>;\n\n <Value>(options?: UseUrlSearchParamsOptions<Value>): UseUrlSearchParamsReturn<Value | undefined>;\n\n <Value>(initialValue: UseUrlSearchParamsInitialValue<Value>): UseUrlSearchParamsReturn<Value>;\n\n <Value>(key: string): UseUrlSearchParamsReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParams\n * @description - Hook that provides reactive URLSearchParams\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsOptions<Value> & { initialValue: UseUrlSearchParamsInitialValue<Value> }} options The options object with required initialValue\n * @param {UseUrlSearchParamsInitialValue<Value>} [options.initialValue] The initial value for the url params\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value[keyof Value]) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value[keyof Value]} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ initialValue: { page: 1 } });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsInitialValue<Value>} [initialValue] The initial value for the url params\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ page: 1 });\n */\nexport const useUrlSearchParams = (<Value extends UrlParams>(\n params: any\n): UseUrlSearchParamsReturn<Value> => {\n const options = (\n typeof params === 'object' &&\n params &&\n ('serializer' in params ||\n 'deserializer' in params ||\n 'initialValue' in params ||\n 'mode' in params ||\n 'write' in params)\n ? params\n : {}\n ) as UseUrlSearchParamsOptions<Value>;\n const initialValue = (\n options ? options?.initialValue : params\n ) as UseUrlSearchParamsInitialValue<Value>;\n\n const { mode = 'history', write: writeMode = 'replace' } = options;\n\n const serializer = (value: Value[keyof Value]) => {\n if (options?.serializer) return options.serializer(value);\n if (typeof value === 'string') return value;\n return JSON.stringify(value);\n };\n\n const deserializer = (value: string) => {\n if (options?.deserializer) return options.deserializer(value);\n if (value === 'undefined') return undefined as unknown as Value[keyof Value];\n\n try {\n return JSON.parse(value) as Value;\n } catch {\n return value as Value[keyof Value];\n }\n };\n\n const setUrlSearchParams = <Value extends UrlParams>(\n mode: UrlSearchParamsMode,\n value: Partial<Value>,\n write: 'push' | 'replace' = 'replace'\n ) => {\n const urlSearchParams = getUrlSearchParams(mode);\n\n Object.entries(value).forEach(([key, param]) => {\n if (param === undefined) {\n urlSearchParams.delete(key);\n } else {\n const serializedValue = serializer ? serializer(param) : String(param);\n urlSearchParams.set(key, serializedValue);\n }\n });\n\n const query = createQueryString(urlSearchParams, mode);\n if (write === 'replace') window.history.replaceState({}, '', query);\n if (write === 'push') window.history.pushState({}, '', query);\n dispatchUrlSearchParamsEvent();\n\n return urlSearchParams;\n };\n\n const getParsedUrlSearchParams = (searchParams: string | UrlParams | URLSearchParams) => {\n if (typeof searchParams === 'string') {\n return getParsedUrlSearchParams(new URLSearchParams(searchParams));\n }\n\n if (searchParams instanceof URLSearchParams) {\n return Array.from(searchParams.entries()).reduce(\n (acc, [key, value]) => {\n acc[key] = deserializer(value);\n return acc;\n },\n {} as Record<string, any>\n );\n }\n\n return searchParams;\n };\n\n const [value, setValue] = useState<Value>(() => {\n if (typeof window === 'undefined') return (initialValue ?? {}) as Value;\n\n const urlSearchParams = getUrlSearchParams(mode);\n const value = {\n ...(initialValue && getParsedUrlSearchParams(initialValue)),\n ...getParsedUrlSearchParams(urlSearchParams)\n } as Value;\n\n setUrlSearchParams(mode, value, writeMode);\n\n return value;\n });\n\n const set = (params: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => {\n const searchParams = setUrlSearchParams(\n mode,\n { ...value, ...params },\n options?.write ?? writeMode\n );\n setValue(getParsedUrlSearchParams(searchParams) as Value);\n };\n\n useEffect(() => {\n const onParamsChange = () => {\n const searchParams = getUrlSearchParams(mode);\n setValue(getParsedUrlSearchParams(searchParams) as Value);\n };\n\n window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.addEventListener('popstate', onParamsChange);\n if (mode !== 'history') window.addEventListener('hashchange', onParamsChange);\n\n return () => {\n window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n window.removeEventListener('popstate', onParamsChange);\n if (mode !== 'history') window.removeEventListener('hashchange', onParamsChange);\n };\n }, [mode]);\n\n return {\n value,\n set\n };\n}) as UseUrlSearchParams;\n\nexport { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams };\n"],"names":["useUrlSearchParams","params","options","initialValue","mode","writeMode","serializer","value","deserializer","setUrlSearchParams","write","urlSearchParams","getUrlSearchParams","key","param","serializedValue","query","createQueryString","dispatchUrlSearchParamsEvent","getParsedUrlSearchParams","searchParams","acc","setValue","useState","set","useEffect","onParamsChange","URL_SEARCH_PARAMS_EVENT"],"mappings":";;AAwFO,MAAMA,KAAsB,CACjCC,MACoC;AACpC,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,CAAA,GAEAE,IACJD,IAAUA,GAAS,eAAeD,GAG9B,EAAE,MAAAG,IAAO,WAAW,OAAOC,IAAY,cAAcH,GAErDI,IAAa,CAACC,MACdL,GAAS,aAAmBA,EAAQ,WAAWK,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAC/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIL,GAAS,aAAc,QAAOA,EAAQ,aAAaK,CAAK;AAC5D,QAAIA,MAAU;AAEd,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAqB,CACzBL,GACAG,GACAG,IAA4B,cACzB;AACH,UAAMC,IAAkBC,EAAmBR,CAAI;AAE/C,WAAO,QAAQG,CAAK,EAAE,QAAQ,CAAC,CAACM,GAAKC,CAAK,MAAM;AAC9C,UAAIA,MAAU;AACZ,QAAAH,EAAgB,OAAOE,CAAG;AAAA,WACrB;AACL,cAAME,IAAkBT,IAAaA,EAAWQ,CAAK,IAAI,OAAOA,CAAK;AACrE,QAAAH,EAAgB,IAAIE,GAAKE,CAAe;AAAA,MAAA;AAAA,IAC1C,CACD;AAED,UAAMC,IAAQC,EAAkBN,GAAiBP,CAAI;AACrD,WAAIM,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIM,CAAK,GAC9DN,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIM,CAAK,GAC5DE,EAAA,GAEOP;AAAA,EAAA,GAGHQ,IAA2B,CAACC,MAC5B,OAAOA,KAAiB,WACnBD,EAAyB,IAAI,gBAAgBC,CAAY,CAAC,IAG/DA,aAAwB,kBACnB,MAAM,KAAKA,EAAa,QAAA,CAAS,EAAE;AAAA,IACxC,CAACC,GAAK,CAACR,GAAKN,CAAK,OACfc,EAAIR,CAAG,IAAIL,EAAaD,CAAK,GACtBc;AAAA,IAET,CAAA;AAAA,EAAC,IAIED,GAGH,CAACb,GAAOe,CAAQ,IAAIC,EAAgB,MAAM;AAC9C,QAAI,OAAO,SAAW,IAAa,QAAQpB,KAAgB,CAAA;AAE3D,UAAMQ,IAAkBC,EAAmBR,CAAI,GACzCG,IAAQ;AAAA,MACZ,GAAIJ,KAAgBgB,EAAyBhB,CAAY;AAAA,MACzD,GAAGgB,EAAyBR,CAAe;AAAA,IAAA;AAG7C,WAAAF,EAAmBL,GAAMG,GAAOF,CAAS,GAElCE;AAAAA,EAAA,CACR,GAEKiB,IAAM,CAACvB,GAAwBC,MAA2C;AAC9E,UAAMkB,IAAeX;AAAA,MACnBL;AAAA,MACA,EAAE,GAAGG,GAAO,GAAGN,EAAAA;AAAAA,MACfC,GAAS,SAASG;AAAA,IAAA;AAEpB,IAAAiB,EAASH,EAAyBC,CAAY,CAAU;AAAA,EAAA;AAG1D,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAC3B,YAAMN,IAAeR,EAAmBR,CAAI;AAC5C,MAAAkB,EAASH,EAAyBC,CAAY,CAAU;AAAA,IAAA;AAG1D,kBAAO,iBAAiBO,GAAyBD,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9CtB,MAAS,aAAW,OAAO,iBAAiB,cAAcsB,CAAc,GAErE,MAAM;AACX,aAAO,oBAAoBC,GAAyBD,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjDtB,MAAS,aAAW,OAAO,oBAAoB,cAAcsB,CAAc;AAAA,IAAA;AAAA,EACjF,GACC,CAACtB,CAAI,CAAC,GAEF;AAAA,IACL,OAAAG;AAAA,IACA,KAAAiB;AAAA,EAAA;AAEJ;"}
@@ -1,33 +1,41 @@
1
- import { useState as d, useRef as C, useEffect as E } from "react";
2
- import { useRefState as R } from "../useRefState/useRefState.mjs";
3
- import { isTarget as c } from "../../utils/helpers/isTarget.mjs";
4
- const V = (...e) => {
5
- const n = c(e[0]) ? e[0] : void 0, t = n ? typeof e[1] == "object" ? e[1] : { onChange: e[1] } : typeof e[0] == "object" ? e[0] : { onChange: e[0] }, i = t?.onChange, f = t?.enabled ?? !0, [u, v] = d(), [o, y] = d(), r = R(), l = C(i);
6
- return l.current = i, E(() => {
1
+ import { useState as d, useRef as R, useEffect as C } from "react";
2
+ import { useRefState as E } from "../useRefState/useRefState.mjs";
3
+ import { isTarget as s } from "../../utils/helpers/isTarget.mjs";
4
+ const S = ((...e) => {
5
+ const n = s(e[0]) ? e[0] : void 0, t = n ? typeof e[1] == "object" ? e[1] : { onChange: e[1] } : typeof e[0] == "object" ? e[0] : { onChange: e[0] }, i = t?.onChange, f = t?.enabled ?? !0, [u, v] = d(), [o, y] = d(), r = E(), l = R(i);
6
+ return l.current = i, C(() => {
7
7
  if (!f || !n && !r.state) return;
8
- const b = n ? c.getElement(n) : r.current;
8
+ const b = n ? s.getElement(n) : r.current;
9
9
  if (!b) return;
10
- const s = new IntersectionObserver(
11
- (h, a) => {
12
- const g = h.pop();
13
- y(g), l.current?.(g, a);
10
+ const c = new IntersectionObserver(
11
+ (a, h) => {
12
+ const g = a.pop();
13
+ y(g), l.current?.(g, h);
14
14
  },
15
15
  {
16
16
  ...t,
17
- root: t?.root ? c.getElement(t.root) : document
17
+ root: t?.root ? s.getElement(t.root) : document
18
18
  }
19
19
  );
20
- return v(s), s.observe(b), () => {
21
- s.disconnect();
20
+ return v(c), c.observe(b), () => {
21
+ c.disconnect();
22
22
  };
23
- }, [n, r.state, t?.rootMargin, t?.threshold, t?.root, f]), n ? { observer: u, entry: o, inView: !!o?.isIntersecting } : {
23
+ }, [
24
+ n,
25
+ r.state,
26
+ s.getRefState(n),
27
+ t?.rootMargin,
28
+ t?.threshold,
29
+ t?.root,
30
+ f
31
+ ]), n ? { observer: u, entry: o, inView: !!o?.isIntersecting } : {
24
32
  observer: u,
25
33
  ref: r,
26
34
  entry: o,
27
35
  inView: !!o?.isIntersecting
28
36
  };
29
- };
37
+ });
30
38
  export {
31
- V as useVisibility
39
+ S as useVisibility
32
40
  };
33
41
  //# sourceMappingURL=useVisibility.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"useVisibility.mjs","sources":["../../../../src/hooks/useVisibility/useVisibility.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport type { HookTarget } from '@/utils/helpers';\n\nimport { isTarget } from '@/utils/helpers';\n\nimport type { StateRef } from '../useRefState/useRefState';\n\nimport { useRefState } from '../useRefState/useRefState';\n\n/** The visibility callback type */\nexport type UseVisibilityCallback = (\n entry: IntersectionObserverEntry,\n observer: IntersectionObserver\n) => void;\n\n/** The visibility options type */\nexport interface UseVisibilityOptions extends Omit<IntersectionObserverInit, 'root'> {\n /** The enabled state of the intersection */\n enabled?: boolean;\n /** The callback to execute when intersection is detected */\n onChange?: UseVisibilityCallback;\n /** The root element to observe */\n root?: HookTarget;\n}\n\n/** The intersection observer return type */\nexport interface UseVisibilityReturn {\n /** The intersection observer entry */\n entry?: IntersectionObserverEntry;\n /** The intersection observer in view */\n inView?: boolean;\n\n /** The intersection observer instance */\n observer?: IntersectionObserver;\n}\n\nexport interface UseVisibility {\n <Target extends Element>(\n options?: UseVisibilityOptions,\n target?: never\n ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n (target: HookTarget, options?: UseVisibilityOptions): UseVisibilityReturn;\n\n <Target extends Element>(\n callback: UseVisibilityCallback,\n target?: never\n ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n (target: HookTarget, callback: UseVisibilityCallback): UseVisibilityReturn;\n}\n\n/**\n * @name useVisibility\n * @description - Hook that gives you visibility observer state\n * @category Sensors\n * @usage medium\n *\n * @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver\n *\n * @overload\n * @param {HookTarget} target The target element to detect intersection\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { ref, entries, observer } = useVisibility();\n *\n * @overload\n * @template Target The target element\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { entries, observer } = useVisibility(ref);\n *\n * @overload\n * @template Target The target element\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { ref, entries, observer } = useVisibility(() => console.log('callback'));\n *\n * @overload\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @param {HookTarget} target The target element to detect intersection\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { entries, observer } = useVisibility(ref, () => console.log('callback'));\n */\nexport const useVisibility = ((...params: any[]) => {\n const target = (isTarget(params[0]) ? params[0] : undefined) as HookTarget | undefined;\n\n const options = (\n target\n ? typeof params[1] === 'object'\n ? params[1]\n : { onChange: params[1] }\n : typeof params[0] === 'object'\n ? params[0]\n : { onChange: params[0] }\n ) as UseVisibilityOptions | undefined;\n\n const callback = options?.onChange;\n const enabled = options?.enabled ?? true;\n\n const [observer, setObserver] = useState<IntersectionObserver>();\n const [entry, setEntry] = useState<IntersectionObserverEntry>();\n\n const internalRef = useRefState<Element>();\n const internalCallbackRef = useRef(callback);\n internalCallbackRef.current = callback;\n\n useEffect(() => {\n if (!enabled || (!target && !internalRef.state)) return;\n\n const element = target ? isTarget.getElement(target) : internalRef.current;\n if (!element) return;\n\n const observer = new IntersectionObserver(\n (entries: IntersectionObserverEntry[], observer: IntersectionObserver) => {\n const entry = entries.pop()!;\n setEntry(entry);\n internalCallbackRef.current?.(entry, observer);\n },\n {\n ...options,\n root: options?.root ? (isTarget.getElement(options.root) as Document | Element) : document\n }\n );\n\n setObserver(observer);\n observer.observe(element as Element);\n\n return () => {\n observer.disconnect();\n };\n }, [target, internalRef.state, options?.rootMargin, options?.threshold, options?.root, enabled]);\n\n if (target) return { observer, entry, inView: !!entry?.isIntersecting };\n return {\n observer,\n ref: internalRef,\n entry,\n inView: !!entry?.isIntersecting\n };\n}) as UseVisibility;\n"],"names":["useVisibility","params","target","isTarget","options","callback","enabled","observer","setObserver","useState","entry","setEntry","internalRef","useRefState","internalCallbackRef","useRef","useEffect","element","entries"],"mappings":";;;AAiGO,MAAMA,IAAiB,IAAIC,MAAkB;AAClD,QAAMC,IAAUC,EAASF,EAAO,CAAC,CAAC,IAAIA,EAAO,CAAC,IAAI,QAE5CG,IACJF,IACI,OAAOD,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,IACtB,OAAOA,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,GAGtBI,IAAWD,GAAS,UACpBE,IAAUF,GAAS,WAAW,IAE9B,CAACG,GAAUC,CAAW,IAAIC,EAAA,GAC1B,CAACC,GAAOC,CAAQ,IAAIF,EAAA,GAEpBG,IAAcC,EAAA,GACdC,IAAsBC,EAAOV,CAAQ;AA6B3C,SA5BAS,EAAoB,UAAUT,GAE9BW,EAAU,MAAM;AACd,QAAI,CAACV,KAAY,CAACJ,KAAU,CAACU,EAAY,MAAQ;AAEjD,UAAMK,IAAUf,IAASC,EAAS,WAAWD,CAAM,IAAIU,EAAY;AACnE,QAAI,CAACK,EAAS;AAEd,UAAMV,IAAW,IAAI;AAAA,MACnB,CAACW,GAAsCX,MAAmC;AACxE,cAAMG,IAAQQ,EAAQ,IAAA;AACtB,QAAAP,EAASD,CAAK,GACdI,EAAoB,UAAUJ,GAAOH,CAAQ;AAAA,MAAA;AAAA,MAE/C;AAAA,QACE,GAAGH;AAAA,QACH,MAAMA,GAAS,OAAQD,EAAS,WAAWC,EAAQ,IAAI,IAA2B;AAAA,MAAA;AAAA,IACpF;AAGF,WAAAI,EAAYD,CAAQ,GACpBA,EAAS,QAAQU,CAAkB,GAE5B,MAAM;AACXV,MAAAA,EAAS,WAAA;AAAA,IAAW;AAAA,EACtB,GACC,CAACL,GAAQU,EAAY,OAAOR,GAAS,YAAYA,GAAS,WAAWA,GAAS,MAAME,CAAO,CAAC,GAE3FJ,IAAe,EAAE,UAAAK,GAAU,OAAAG,GAAO,QAAQ,CAAC,CAACA,GAAO,eAAA,IAChD;AAAA,IACL,UAAAH;AAAA,IACA,KAAKK;AAAA,IACL,OAAAF;AAAA,IACA,QAAQ,CAAC,CAACA,GAAO;AAAA,EAAA;AAErB;"}
1
+ {"version":3,"file":"useVisibility.mjs","sources":["../../../../src/hooks/useVisibility/useVisibility.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport type { HookTarget } from '@/utils/helpers';\n\nimport { isTarget } from '@/utils/helpers';\n\nimport type { StateRef } from '../useRefState/useRefState';\n\nimport { useRefState } from '../useRefState/useRefState';\n\n/** The visibility callback type */\nexport type UseVisibilityCallback = (\n entry: IntersectionObserverEntry,\n observer: IntersectionObserver\n) => void;\n\n/** The visibility options type */\nexport interface UseVisibilityOptions extends Omit<IntersectionObserverInit, 'root'> {\n /** The enabled state of the intersection */\n enabled?: boolean;\n /** The callback to execute when intersection is detected */\n onChange?: UseVisibilityCallback;\n /** The root element to observe */\n root?: HookTarget;\n}\n\n/** The intersection observer return type */\nexport interface UseVisibilityReturn {\n /** The intersection observer entry */\n entry?: IntersectionObserverEntry;\n /** The intersection observer in view */\n inView?: boolean;\n\n /** The intersection observer instance */\n observer?: IntersectionObserver;\n}\n\nexport interface UseVisibility {\n <Target extends Element>(\n options?: UseVisibilityOptions,\n target?: never\n ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n (target: HookTarget, options?: UseVisibilityOptions): UseVisibilityReturn;\n\n <Target extends Element>(\n callback: UseVisibilityCallback,\n target?: never\n ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n (target: HookTarget, callback: UseVisibilityCallback): UseVisibilityReturn;\n}\n\n/**\n * @name useVisibility\n * @description - Hook that gives you visibility observer state\n * @category Sensors\n * @usage medium\n *\n * @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver\n *\n * @overload\n * @param {HookTarget} target The target element to detect intersection\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { ref, entries, observer } = useVisibility();\n *\n * @overload\n * @template Target The target element\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { entries, observer } = useVisibility(ref);\n *\n * @overload\n * @template Target The target element\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { ref, entries, observer } = useVisibility(() => console.log('callback'));\n *\n * @overload\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @param {HookTarget} target The target element to detect intersection\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { entries, observer } = useVisibility(ref, () => console.log('callback'));\n */\nexport const useVisibility = ((...params: any[]) => {\n const target = (isTarget(params[0]) ? params[0] : undefined) as HookTarget | undefined;\n\n const options = (\n target\n ? typeof params[1] === 'object'\n ? params[1]\n : { onChange: params[1] }\n : typeof params[0] === 'object'\n ? params[0]\n : { onChange: params[0] }\n ) as UseVisibilityOptions | undefined;\n\n const callback = options?.onChange;\n const enabled = options?.enabled ?? true;\n\n const [observer, setObserver] = useState<IntersectionObserver>();\n const [entry, setEntry] = useState<IntersectionObserverEntry>();\n\n const internalRef = useRefState<Element>();\n const internalCallbackRef = useRef(callback);\n internalCallbackRef.current = callback;\n\n useEffect(() => {\n if (!enabled || (!target && !internalRef.state)) return;\n\n const element = target ? isTarget.getElement(target) : internalRef.current;\n if (!element) return;\n\n const observer = new IntersectionObserver(\n (entries: IntersectionObserverEntry[], observer: IntersectionObserver) => {\n const entry = entries.pop()!;\n setEntry(entry);\n internalCallbackRef.current?.(entry, observer);\n },\n {\n ...options,\n root: options?.root ? (isTarget.getElement(options.root) as Document | Element) : document\n }\n );\n\n setObserver(observer);\n observer.observe(element as Element);\n\n return () => {\n observer.disconnect();\n };\n }, [\n target,\n internalRef.state,\n isTarget.getRefState(target),\n options?.rootMargin,\n options?.threshold,\n options?.root,\n enabled\n ]);\n\n if (target) return { observer, entry, inView: !!entry?.isIntersecting };\n return {\n observer,\n ref: internalRef,\n entry,\n inView: !!entry?.isIntersecting\n };\n}) as UseVisibility;\n"],"names":["useVisibility","params","target","isTarget","options","callback","enabled","observer","setObserver","useState","entry","setEntry","internalRef","useRefState","internalCallbackRef","useRef","useEffect","element","entries"],"mappings":";;;AAiGO,MAAMA,KAAiB,IAAIC,MAAkB;AAClD,QAAMC,IAAUC,EAASF,EAAO,CAAC,CAAC,IAAIA,EAAO,CAAC,IAAI,QAE5CG,IACJF,IACI,OAAOD,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,IACtB,OAAOA,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,GAGtBI,IAAWD,GAAS,UACpBE,IAAUF,GAAS,WAAW,IAE9B,CAACG,GAAUC,CAAW,IAAIC,EAAA,GAC1B,CAACC,GAAOC,CAAQ,IAAIF,EAAA,GAEpBG,IAAcC,EAAA,GACdC,IAAsBC,EAAOV,CAAQ;AAqC3C,SApCAS,EAAoB,UAAUT,GAE9BW,EAAU,MAAM;AACd,QAAI,CAACV,KAAY,CAACJ,KAAU,CAACU,EAAY,MAAQ;AAEjD,UAAMK,IAAUf,IAASC,EAAS,WAAWD,CAAM,IAAIU,EAAY;AACnE,QAAI,CAACK,EAAS;AAEd,UAAMV,IAAW,IAAI;AAAA,MACnB,CAACW,GAAsCX,MAAmC;AACxE,cAAMG,IAAQQ,EAAQ,IAAA;AACtB,QAAAP,EAASD,CAAK,GACdI,EAAoB,UAAUJ,GAAOH,CAAQ;AAAA,MAAA;AAAA,MAE/C;AAAA,QACE,GAAGH;AAAA,QACH,MAAMA,GAAS,OAAQD,EAAS,WAAWC,EAAQ,IAAI,IAA2B;AAAA,MAAA;AAAA,IACpF;AAGF,WAAAI,EAAYD,CAAQ,GACpBA,EAAS,QAAQU,CAAkB,GAE5B,MAAM;AACXV,MAAAA,EAAS,WAAA;AAAA,IAAW;AAAA,EACtB,GACC;AAAA,IACDL;AAAA,IACAU,EAAY;AAAA,IACZT,EAAS,YAAYD,CAAM;AAAA,IAC3BE,GAAS;AAAA,IACTA,GAAS;AAAA,IACTA,GAAS;AAAA,IACTE;AAAA,EAAA,CACD,GAEGJ,IAAe,EAAE,UAAAK,GAAU,OAAAG,GAAO,QAAQ,CAAC,CAACA,GAAO,eAAA,IAChD;AAAA,IACL,UAAAH;AAAA,IACA,KAAKK;AAAA,IACL,OAAAF;AAAA,IACA,QAAQ,CAAC,CAACA,GAAO;AAAA,EAAA;AAErB;"}