@oneplatformdev/hooks 0.1.0-15 → 0.1.0-150

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 (223) hide show
  1. package/CHANGELOG.md +585 -0
  2. package/index.d.ts +37 -0
  3. package/index.d.ts.map +1 -0
  4. package/package.json +14 -20
  5. package/useBoolean/index.d.ts +2 -0
  6. package/useBoolean/index.d.ts.map +1 -0
  7. package/useBoolean/index.js +4 -0
  8. package/useBoolean/useBoolean.d.ts +29 -0
  9. package/useBoolean/useBoolean.d.ts.map +1 -0
  10. package/useBoolean/useBoolean.js +16 -0
  11. package/useClickAnyWhere/index.d.ts +2 -0
  12. package/useClickAnyWhere/index.d.ts.map +1 -0
  13. package/useClickAnyWhere/index.js +4 -0
  14. package/useClickAnyWhere/useClickAnyWhere.d.ts +17 -0
  15. package/useClickAnyWhere/useClickAnyWhere.d.ts.map +1 -0
  16. package/useClickAnyWhere/useClickAnyWhere.js +9 -0
  17. package/useCopyToClipboard/index.d.ts +2 -0
  18. package/useCopyToClipboard/index.d.ts.map +1 -0
  19. package/useCopyToClipboard/index.js +4 -0
  20. package/useCopyToClipboard/useCopyToClipboard.d.ts +34 -0
  21. package/useCopyToClipboard/useCopyToClipboard.d.ts.map +1 -0
  22. package/useCopyToClipboard/useCopyToClipboard.js +16 -0
  23. package/useCountdown/index.d.ts +2 -0
  24. package/useCountdown/index.d.ts.map +1 -0
  25. package/useCountdown/index.js +4 -0
  26. package/useCountdown/useCountdown.d.ts +47 -0
  27. package/useCountdown/useCountdown.d.ts.map +1 -0
  28. package/useCountdown/useCountdown.js +33 -0
  29. package/useCounter/index.d.ts +2 -0
  30. package/useCounter/index.d.ts.map +1 -0
  31. package/useCounter/index.js +4 -0
  32. package/useCounter/useCounter.d.ts +28 -0
  33. package/useCounter/useCounter.d.ts.map +1 -0
  34. package/useCounter/useCounter.js +20 -0
  35. package/useDarkMode/index.d.ts +2 -0
  36. package/useDarkMode/index.d.ts.map +1 -0
  37. package/useDarkMode/index.js +4 -0
  38. package/useDarkMode/useDarkMode.d.ts +46 -0
  39. package/useDarkMode/useDarkMode.d.ts.map +1 -0
  40. package/useDarkMode/useDarkMode.js +38 -0
  41. package/useDebounceCallback/index.d.ts +3 -0
  42. package/useDebounceCallback/index.d.ts.map +1 -0
  43. package/useDebounceCallback/index.js +5 -0
  44. package/useDebounceCallback/useDebounceCallback.d.ts +62 -0
  45. package/useDebounceCallback/useDebounceCallback.d.ts.map +1 -0
  46. package/useDebounceCallback/useDebounceCallback.js +21 -0
  47. package/useDebounceValue/index.d.ts +2 -0
  48. package/useDebounceValue/index.d.ts.map +1 -0
  49. package/useDebounceValue/index.js +4 -0
  50. package/useDebounceValue/useDebounceValue.d.ts +40 -0
  51. package/useDebounceValue/useDebounceValue.d.ts.map +1 -0
  52. package/useDebounceValue/useDebounceValue.js +13 -0
  53. package/useDocumentTitle/index.d.ts +2 -0
  54. package/useDocumentTitle/index.d.ts.map +1 -0
  55. package/useDocumentTitle/index.js +4 -0
  56. package/useDocumentTitle/useDocumentTitle.d.ts +19 -0
  57. package/useDocumentTitle/useDocumentTitle.d.ts.map +1 -0
  58. package/useDocumentTitle/useDocumentTitle.js +16 -0
  59. package/useEventCallback/index.d.ts +2 -0
  60. package/useEventCallback/index.d.ts.map +1 -0
  61. package/useEventCallback/index.js +4 -0
  62. package/useEventCallback/useEventCallback.d.ts +18 -0
  63. package/useEventCallback/useEventCallback.d.ts.map +1 -0
  64. package/useEventCallback/useEventCallback.js +13 -0
  65. package/useEventListener/index.d.ts +2 -0
  66. package/useEventListener/index.d.ts.map +1 -0
  67. package/useEventListener/index.js +4 -0
  68. package/useEventListener/useEventListener.d.ts +9 -0
  69. package/useEventListener/useEventListener.d.ts.map +1 -0
  70. package/useEventListener/useEventListener.js +20 -0
  71. package/useHover/index.d.ts +2 -0
  72. package/useHover/index.d.ts.map +1 -0
  73. package/useHover/index.js +4 -0
  74. package/useHover/useHover.d.ts +17 -0
  75. package/useHover/useHover.d.ts.map +1 -0
  76. package/useHover/useHover.js +13 -0
  77. package/useIntersectionObserver/index.d.ts +2 -0
  78. package/useIntersectionObserver/index.d.ts.map +1 -0
  79. package/useIntersectionObserver/index.js +4 -0
  80. package/useIntersectionObserver/useIntersectionObserver.d.ts +72 -0
  81. package/useIntersectionObserver/useIntersectionObserver.d.ts.map +1 -0
  82. package/useIntersectionObserver/useIntersectionObserver.js +53 -0
  83. package/useInterval/index.d.ts +2 -0
  84. package/useInterval/index.d.ts.map +1 -0
  85. package/useInterval/index.js +4 -0
  86. package/useInterval/useInterval.d.ts +16 -0
  87. package/useInterval/useInterval.d.ts.map +1 -0
  88. package/useInterval/useInterval.js +20 -0
  89. package/useIsClient/index.d.ts +2 -0
  90. package/useIsClient/index.d.ts.map +1 -0
  91. package/useIsClient/index.js +4 -0
  92. package/useIsClient/useIsClient.d.ts +13 -0
  93. package/useIsClient/useIsClient.d.ts.map +1 -0
  94. package/useIsClient/useIsClient.js +10 -0
  95. package/useIsMobile/index.d.ts +3 -0
  96. package/useIsMobile/index.d.ts.map +1 -0
  97. package/useIsMobile/index.js +4 -0
  98. package/useIsMobile/types.d.ts +4 -0
  99. package/useIsMobile/types.d.ts.map +1 -0
  100. package/useIsMobile/types.js +1 -0
  101. package/useIsMobile/useIsMobile.d.ts +3 -0
  102. package/useIsMobile/useIsMobile.d.ts.map +1 -0
  103. package/useIsMobile/useIsMobile.js +16 -0
  104. package/useIsMounted/index.d.ts +2 -0
  105. package/useIsMounted/index.d.ts.map +1 -0
  106. package/useIsMounted/index.js +4 -0
  107. package/useIsMounted/useIsMounted.d.ts +2 -0
  108. package/useIsMounted/useIsMounted.d.ts.map +1 -0
  109. package/useIsMounted/useIsMounted.js +10 -0
  110. package/useIsomorphicLayoutEffect/index.d.ts +2 -0
  111. package/useIsomorphicLayoutEffect/index.d.ts.map +1 -0
  112. package/useIsomorphicLayoutEffect/index.js +4 -0
  113. package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts +16 -0
  114. package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts.map +1 -0
  115. package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +5 -0
  116. package/useLocalStorage/index.d.ts +2 -0
  117. package/useLocalStorage/index.d.ts.map +1 -0
  118. package/useLocalStorage/index.js +4 -0
  119. package/useLocalStorage/useLocalStorage.d.ts +39 -0
  120. package/useLocalStorage/useLocalStorage.d.ts.map +1 -0
  121. package/useLocalStorage/useLocalStorage.js +65 -0
  122. package/useLockBody/index.d.ts +2 -0
  123. package/useLockBody/index.d.ts.map +1 -0
  124. package/useLockBody/index.js +4 -0
  125. package/useLockBody/useLockBody.d.ts +2 -0
  126. package/useLockBody/useLockBody.d.ts.map +1 -0
  127. package/useLockBody/useLockBody.js +12 -0
  128. package/useMap/index.d.ts +2 -0
  129. package/useMap/index.d.ts.map +1 -0
  130. package/useMap/index.js +4 -0
  131. package/useMap/useMap.d.ts +48 -0
  132. package/useMap/useMap.d.ts.map +1 -0
  133. package/useMap/useMap.js +27 -0
  134. package/useMediaQuery/index.d.ts +2 -0
  135. package/useMediaQuery/index.d.ts.map +1 -0
  136. package/useMediaQuery/index.js +4 -0
  137. package/useMediaQuery/useMediaQuery.d.ts +29 -0
  138. package/useMediaQuery/useMediaQuery.d.ts.map +1 -0
  139. package/useMediaQuery/useMediaQuery.js +21 -0
  140. package/useOnClickOutside/index.d.ts +2 -0
  141. package/useOnClickOutside/index.d.ts.map +1 -0
  142. package/useOnClickOutside/index.js +4 -0
  143. package/useOnClickOutside/useOnClickOutside.d.ts +24 -0
  144. package/useOnClickOutside/useOnClickOutside.d.ts.map +1 -0
  145. package/useOnClickOutside/useOnClickOutside.js +17 -0
  146. package/useQueryString/index.d.ts +2 -0
  147. package/useQueryString/index.d.ts.map +1 -0
  148. package/useQueryString/index.js +4 -0
  149. package/useQueryString/useQueryString.d.ts +10 -0
  150. package/useQueryString/useQueryString.d.ts.map +1 -0
  151. package/useQueryString/useQueryString.js +10 -0
  152. package/useReadLocalStorage/index.d.ts +2 -0
  153. package/useReadLocalStorage/index.d.ts.map +1 -0
  154. package/useReadLocalStorage/index.js +4 -0
  155. package/useReadLocalStorage/useReadLocalStorage.d.ts +14 -0
  156. package/useReadLocalStorage/useReadLocalStorage.d.ts.map +1 -0
  157. package/useReadLocalStorage/useReadLocalStorage.js +48 -0
  158. package/useResizeObserver/index.d.ts +2 -0
  159. package/useResizeObserver/index.d.ts.map +1 -0
  160. package/useResizeObserver/index.js +4 -0
  161. package/useResizeObserver/useResizeObserver.d.ts +44 -0
  162. package/useResizeObserver/useResizeObserver.d.ts.map +1 -0
  163. package/useResizeObserver/useResizeObserver.js +31 -0
  164. package/useScreen/index.d.ts +2 -0
  165. package/useScreen/index.d.ts.map +1 -0
  166. package/useScreen/index.js +4 -0
  167. package/useScreen/useScreen.d.ts +20 -0
  168. package/useScreen/useScreen.d.ts.map +1 -0
  169. package/useScreen/useScreen.js +48 -0
  170. package/useScript/index.d.ts +2 -0
  171. package/useScript/index.d.ts.map +1 -0
  172. package/useScript/index.js +4 -0
  173. package/useScript/useScript.d.ts +24 -0
  174. package/useScript/useScript.d.ts.map +1 -0
  175. package/useScript/useScript.js +45 -0
  176. package/useScrollLock/index.d.ts +2 -0
  177. package/useScrollLock/index.d.ts.map +1 -0
  178. package/useScrollLock/index.js +4 -0
  179. package/useScrollLock/useScrollLock.d.ts +54 -0
  180. package/useScrollLock/useScrollLock.d.ts.map +1 -0
  181. package/useScrollLock/useScrollLock.js +26 -0
  182. package/useSessionStorage/index.d.ts +2 -0
  183. package/useSessionStorage/index.d.ts.map +1 -0
  184. package/useSessionStorage/index.js +4 -0
  185. package/useSessionStorage/useSessionStorage.d.ts +39 -0
  186. package/useSessionStorage/useSessionStorage.d.ts.map +1 -0
  187. package/useSessionStorage/useSessionStorage.js +65 -0
  188. package/useStep/index.d.ts +2 -0
  189. package/useStep/index.d.ts.map +1 -0
  190. package/useStep/index.js +4 -0
  191. package/useStep/useStep.d.ts +31 -0
  192. package/useStep/useStep.d.ts.map +1 -0
  193. package/useStep/useStep.js +34 -0
  194. package/useTernaryDarkMode/index.d.ts +2 -0
  195. package/useTernaryDarkMode/index.d.ts.map +1 -0
  196. package/useTernaryDarkMode/index.js +4 -0
  197. package/useTernaryDarkMode/useTernaryDarkMode.d.ts +46 -0
  198. package/useTernaryDarkMode/useTernaryDarkMode.d.ts.map +1 -0
  199. package/useTernaryDarkMode/useTernaryDarkMode.js +27 -0
  200. package/useTimeout/index.d.ts +2 -0
  201. package/useTimeout/index.d.ts.map +1 -0
  202. package/useTimeout/index.js +4 -0
  203. package/useTimeout/useTimeout.d.ts +17 -0
  204. package/useTimeout/useTimeout.d.ts.map +1 -0
  205. package/useTimeout/useTimeout.js +20 -0
  206. package/useToggle/index.d.ts +2 -0
  207. package/useToggle/index.d.ts.map +1 -0
  208. package/useToggle/index.js +4 -0
  209. package/useToggle/useToggle.d.ts +18 -0
  210. package/useToggle/useToggle.d.ts.map +1 -0
  211. package/useToggle/useToggle.js +10 -0
  212. package/useUnmount/index.d.ts +2 -0
  213. package/useUnmount/index.d.ts.map +1 -0
  214. package/useUnmount/index.js +4 -0
  215. package/useUnmount/useUnmount.d.ts +14 -0
  216. package/useUnmount/useUnmount.d.ts.map +1 -0
  217. package/useUnmount/useUnmount.js +13 -0
  218. package/useWindowSize/index.d.ts +2 -0
  219. package/useWindowSize/index.d.ts.map +1 -0
  220. package/useWindowSize/index.js +4 -0
  221. package/useWindowSize/useWindowSize.d.ts +30 -0
  222. package/useWindowSize/useWindowSize.d.ts.map +1 -0
  223. package/useWindowSize/useWindowSize.js +31 -0
@@ -0,0 +1,2 @@
1
+ export * from './useWindowSize';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/useWindowSize/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}
@@ -0,0 +1,4 @@
1
+ import { useWindowSize as i } from "./useWindowSize.js";
2
+ export {
3
+ i as useWindowSize
4
+ };
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Represent the dimension of the window.
3
+ * @template T - The type of the dimension (number or undefined).
4
+ */
5
+ type WindowSize<T extends number | undefined = number | undefined> = {
6
+ /** The width of the window. */
7
+ width: T;
8
+ /** The height of the window. */
9
+ height: T;
10
+ };
11
+ /**
12
+ * Hook options.
13
+ * @template InitializeWithValue - If `true` (default), the hook will initialize reading the window size. In SSR, you should set it to `false`, returning `undefined` initially.
14
+ */
15
+ type UseWindowSizeOptions<InitializeWithValue extends boolean | undefined> = {
16
+ /**
17
+ * If `true` (default), the hook will initialize reading the window size. In SSR, you should set it to `false`, returning `undefined` initially.
18
+ * @default true
19
+ */
20
+ initializeWithValue: InitializeWithValue;
21
+ /**
22
+ * The delay in milliseconds before the state is updated (disabled by default for retro-compatibility).
23
+ * @default undefined
24
+ */
25
+ debounceDelay?: number;
26
+ };
27
+ export declare function useWindowSize(options: UseWindowSizeOptions<false>): WindowSize;
28
+ export declare function useWindowSize(options?: Partial<UseWindowSizeOptions<true>>): WindowSize<number>;
29
+ export {};
30
+ //# sourceMappingURL=useWindowSize.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useWindowSize.d.ts","sourceRoot":"","sources":["../../src/useWindowSize/useWindowSize.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IAAI;IACnE,+BAA+B;IAC/B,KAAK,EAAE,CAAC,CAAA;IACR,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAA;CACV,CAAA;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,mBAAmB,SAAS,OAAO,GAAG,SAAS,IAAI;IAC3E;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAKD,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAA;AAE/E,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,GAC5C,UAAU,CAAC,MAAM,CAAC,CAAA"}
@@ -0,0 +1,31 @@
1
+ import { useState as r } from "react";
2
+ import { useDebounceCallback as u } from "../useDebounceCallback/useDebounceCallback.js";
3
+ import { useEventListener as w } from "../useEventListener/useEventListener.js";
4
+ import { useIsomorphicLayoutEffect as h } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";
5
+ const s = typeof window > "u";
6
+ function m(e = {}) {
7
+ let { initializeWithValue: i = !0 } = e;
8
+ s && (i = !1);
9
+ const [o, t] = r(() => i ? {
10
+ width: window.innerWidth,
11
+ height: window.innerHeight
12
+ } : {
13
+ width: void 0,
14
+ height: void 0
15
+ }), d = u(
16
+ t,
17
+ e.debounceDelay
18
+ );
19
+ function n() {
20
+ (e.debounceDelay ? d : t)({
21
+ width: window.innerWidth,
22
+ height: window.innerHeight
23
+ });
24
+ }
25
+ return w("resize", n), h(() => {
26
+ n();
27
+ }, []), o;
28
+ }
29
+ export {
30
+ m as useWindowSize
31
+ };