@oneplatformdev/hooks 0.1.0-15 → 0.1.0-151
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.
- package/CHANGELOG.md +589 -0
- package/index.d.ts +37 -0
- package/index.d.ts.map +1 -0
- package/package.json +14 -20
- package/useBoolean/index.d.ts +2 -0
- package/useBoolean/index.d.ts.map +1 -0
- package/useBoolean/index.js +4 -0
- package/useBoolean/useBoolean.d.ts +29 -0
- package/useBoolean/useBoolean.d.ts.map +1 -0
- package/useBoolean/useBoolean.js +16 -0
- package/useClickAnyWhere/index.d.ts +2 -0
- package/useClickAnyWhere/index.d.ts.map +1 -0
- package/useClickAnyWhere/index.js +4 -0
- package/useClickAnyWhere/useClickAnyWhere.d.ts +17 -0
- package/useClickAnyWhere/useClickAnyWhere.d.ts.map +1 -0
- package/useClickAnyWhere/useClickAnyWhere.js +9 -0
- package/useCopyToClipboard/index.d.ts +2 -0
- package/useCopyToClipboard/index.d.ts.map +1 -0
- package/useCopyToClipboard/index.js +4 -0
- package/useCopyToClipboard/useCopyToClipboard.d.ts +34 -0
- package/useCopyToClipboard/useCopyToClipboard.d.ts.map +1 -0
- package/useCopyToClipboard/useCopyToClipboard.js +16 -0
- package/useCountdown/index.d.ts +2 -0
- package/useCountdown/index.d.ts.map +1 -0
- package/useCountdown/index.js +4 -0
- package/useCountdown/useCountdown.d.ts +47 -0
- package/useCountdown/useCountdown.d.ts.map +1 -0
- package/useCountdown/useCountdown.js +33 -0
- package/useCounter/index.d.ts +2 -0
- package/useCounter/index.d.ts.map +1 -0
- package/useCounter/index.js +4 -0
- package/useCounter/useCounter.d.ts +28 -0
- package/useCounter/useCounter.d.ts.map +1 -0
- package/useCounter/useCounter.js +20 -0
- package/useDarkMode/index.d.ts +2 -0
- package/useDarkMode/index.d.ts.map +1 -0
- package/useDarkMode/index.js +4 -0
- package/useDarkMode/useDarkMode.d.ts +46 -0
- package/useDarkMode/useDarkMode.d.ts.map +1 -0
- package/useDarkMode/useDarkMode.js +38 -0
- package/useDebounceCallback/index.d.ts +3 -0
- package/useDebounceCallback/index.d.ts.map +1 -0
- package/useDebounceCallback/index.js +5 -0
- package/useDebounceCallback/useDebounceCallback.d.ts +62 -0
- package/useDebounceCallback/useDebounceCallback.d.ts.map +1 -0
- package/useDebounceCallback/useDebounceCallback.js +21 -0
- package/useDebounceValue/index.d.ts +2 -0
- package/useDebounceValue/index.d.ts.map +1 -0
- package/useDebounceValue/index.js +4 -0
- package/useDebounceValue/useDebounceValue.d.ts +40 -0
- package/useDebounceValue/useDebounceValue.d.ts.map +1 -0
- package/useDebounceValue/useDebounceValue.js +13 -0
- package/useDocumentTitle/index.d.ts +2 -0
- package/useDocumentTitle/index.d.ts.map +1 -0
- package/useDocumentTitle/index.js +4 -0
- package/useDocumentTitle/useDocumentTitle.d.ts +19 -0
- package/useDocumentTitle/useDocumentTitle.d.ts.map +1 -0
- package/useDocumentTitle/useDocumentTitle.js +16 -0
- package/useEventCallback/index.d.ts +2 -0
- package/useEventCallback/index.d.ts.map +1 -0
- package/useEventCallback/index.js +4 -0
- package/useEventCallback/useEventCallback.d.ts +18 -0
- package/useEventCallback/useEventCallback.d.ts.map +1 -0
- package/useEventCallback/useEventCallback.js +13 -0
- package/useEventListener/index.d.ts +2 -0
- package/useEventListener/index.d.ts.map +1 -0
- package/useEventListener/index.js +4 -0
- package/useEventListener/useEventListener.d.ts +9 -0
- package/useEventListener/useEventListener.d.ts.map +1 -0
- package/useEventListener/useEventListener.js +20 -0
- package/useHover/index.d.ts +2 -0
- package/useHover/index.d.ts.map +1 -0
- package/useHover/index.js +4 -0
- package/useHover/useHover.d.ts +17 -0
- package/useHover/useHover.d.ts.map +1 -0
- package/useHover/useHover.js +13 -0
- package/useIntersectionObserver/index.d.ts +2 -0
- package/useIntersectionObserver/index.d.ts.map +1 -0
- package/useIntersectionObserver/index.js +4 -0
- package/useIntersectionObserver/useIntersectionObserver.d.ts +72 -0
- package/useIntersectionObserver/useIntersectionObserver.d.ts.map +1 -0
- package/useIntersectionObserver/useIntersectionObserver.js +53 -0
- package/useInterval/index.d.ts +2 -0
- package/useInterval/index.d.ts.map +1 -0
- package/useInterval/index.js +4 -0
- package/useInterval/useInterval.d.ts +16 -0
- package/useInterval/useInterval.d.ts.map +1 -0
- package/useInterval/useInterval.js +20 -0
- package/useIsClient/index.d.ts +2 -0
- package/useIsClient/index.d.ts.map +1 -0
- package/useIsClient/index.js +4 -0
- package/useIsClient/useIsClient.d.ts +13 -0
- package/useIsClient/useIsClient.d.ts.map +1 -0
- package/useIsClient/useIsClient.js +10 -0
- package/useIsMobile/index.d.ts +3 -0
- package/useIsMobile/index.d.ts.map +1 -0
- package/useIsMobile/index.js +4 -0
- package/useIsMobile/types.d.ts +4 -0
- package/useIsMobile/types.d.ts.map +1 -0
- package/useIsMobile/types.js +1 -0
- package/useIsMobile/useIsMobile.d.ts +3 -0
- package/useIsMobile/useIsMobile.d.ts.map +1 -0
- package/useIsMobile/useIsMobile.js +16 -0
- package/useIsMounted/index.d.ts +2 -0
- package/useIsMounted/index.d.ts.map +1 -0
- package/useIsMounted/index.js +4 -0
- package/useIsMounted/useIsMounted.d.ts +2 -0
- package/useIsMounted/useIsMounted.d.ts.map +1 -0
- package/useIsMounted/useIsMounted.js +10 -0
- package/useIsomorphicLayoutEffect/index.d.ts +2 -0
- package/useIsomorphicLayoutEffect/index.d.ts.map +1 -0
- package/useIsomorphicLayoutEffect/index.js +4 -0
- package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts +16 -0
- package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.d.ts.map +1 -0
- package/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js +5 -0
- package/useLocalStorage/index.d.ts +2 -0
- package/useLocalStorage/index.d.ts.map +1 -0
- package/useLocalStorage/index.js +4 -0
- package/useLocalStorage/useLocalStorage.d.ts +39 -0
- package/useLocalStorage/useLocalStorage.d.ts.map +1 -0
- package/useLocalStorage/useLocalStorage.js +65 -0
- package/useLockBody/index.d.ts +2 -0
- package/useLockBody/index.d.ts.map +1 -0
- package/useLockBody/index.js +4 -0
- package/useLockBody/useLockBody.d.ts +2 -0
- package/useLockBody/useLockBody.d.ts.map +1 -0
- package/useLockBody/useLockBody.js +12 -0
- package/useMap/index.d.ts +2 -0
- package/useMap/index.d.ts.map +1 -0
- package/useMap/index.js +4 -0
- package/useMap/useMap.d.ts +48 -0
- package/useMap/useMap.d.ts.map +1 -0
- package/useMap/useMap.js +27 -0
- package/useMediaQuery/index.d.ts +2 -0
- package/useMediaQuery/index.d.ts.map +1 -0
- package/useMediaQuery/index.js +4 -0
- package/useMediaQuery/useMediaQuery.d.ts +29 -0
- package/useMediaQuery/useMediaQuery.d.ts.map +1 -0
- package/useMediaQuery/useMediaQuery.js +21 -0
- package/useOnClickOutside/index.d.ts +2 -0
- package/useOnClickOutside/index.d.ts.map +1 -0
- package/useOnClickOutside/index.js +4 -0
- package/useOnClickOutside/useOnClickOutside.d.ts +24 -0
- package/useOnClickOutside/useOnClickOutside.d.ts.map +1 -0
- package/useOnClickOutside/useOnClickOutside.js +17 -0
- package/useQueryString/index.d.ts +2 -0
- package/useQueryString/index.d.ts.map +1 -0
- package/useQueryString/index.js +4 -0
- package/useQueryString/useQueryString.d.ts +10 -0
- package/useQueryString/useQueryString.d.ts.map +1 -0
- package/useQueryString/useQueryString.js +10 -0
- package/useReadLocalStorage/index.d.ts +2 -0
- package/useReadLocalStorage/index.d.ts.map +1 -0
- package/useReadLocalStorage/index.js +4 -0
- package/useReadLocalStorage/useReadLocalStorage.d.ts +14 -0
- package/useReadLocalStorage/useReadLocalStorage.d.ts.map +1 -0
- package/useReadLocalStorage/useReadLocalStorage.js +48 -0
- package/useResizeObserver/index.d.ts +2 -0
- package/useResizeObserver/index.d.ts.map +1 -0
- package/useResizeObserver/index.js +4 -0
- package/useResizeObserver/useResizeObserver.d.ts +44 -0
- package/useResizeObserver/useResizeObserver.d.ts.map +1 -0
- package/useResizeObserver/useResizeObserver.js +31 -0
- package/useScreen/index.d.ts +2 -0
- package/useScreen/index.d.ts.map +1 -0
- package/useScreen/index.js +4 -0
- package/useScreen/useScreen.d.ts +20 -0
- package/useScreen/useScreen.d.ts.map +1 -0
- package/useScreen/useScreen.js +48 -0
- package/useScript/index.d.ts +2 -0
- package/useScript/index.d.ts.map +1 -0
- package/useScript/index.js +4 -0
- package/useScript/useScript.d.ts +24 -0
- package/useScript/useScript.d.ts.map +1 -0
- package/useScript/useScript.js +45 -0
- package/useScrollLock/index.d.ts +2 -0
- package/useScrollLock/index.d.ts.map +1 -0
- package/useScrollLock/index.js +4 -0
- package/useScrollLock/useScrollLock.d.ts +54 -0
- package/useScrollLock/useScrollLock.d.ts.map +1 -0
- package/useScrollLock/useScrollLock.js +26 -0
- package/useSessionStorage/index.d.ts +2 -0
- package/useSessionStorage/index.d.ts.map +1 -0
- package/useSessionStorage/index.js +4 -0
- package/useSessionStorage/useSessionStorage.d.ts +39 -0
- package/useSessionStorage/useSessionStorage.d.ts.map +1 -0
- package/useSessionStorage/useSessionStorage.js +65 -0
- package/useStep/index.d.ts +2 -0
- package/useStep/index.d.ts.map +1 -0
- package/useStep/index.js +4 -0
- package/useStep/useStep.d.ts +31 -0
- package/useStep/useStep.d.ts.map +1 -0
- package/useStep/useStep.js +34 -0
- package/useTernaryDarkMode/index.d.ts +2 -0
- package/useTernaryDarkMode/index.d.ts.map +1 -0
- package/useTernaryDarkMode/index.js +4 -0
- package/useTernaryDarkMode/useTernaryDarkMode.d.ts +46 -0
- package/useTernaryDarkMode/useTernaryDarkMode.d.ts.map +1 -0
- package/useTernaryDarkMode/useTernaryDarkMode.js +27 -0
- package/useTimeout/index.d.ts +2 -0
- package/useTimeout/index.d.ts.map +1 -0
- package/useTimeout/index.js +4 -0
- package/useTimeout/useTimeout.d.ts +17 -0
- package/useTimeout/useTimeout.d.ts.map +1 -0
- package/useTimeout/useTimeout.js +20 -0
- package/useToggle/index.d.ts +2 -0
- package/useToggle/index.d.ts.map +1 -0
- package/useToggle/index.js +4 -0
- package/useToggle/useToggle.d.ts +18 -0
- package/useToggle/useToggle.d.ts.map +1 -0
- package/useToggle/useToggle.js +10 -0
- package/useUnmount/index.d.ts +2 -0
- package/useUnmount/index.d.ts.map +1 -0
- package/useUnmount/index.js +4 -0
- package/useUnmount/useUnmount.d.ts +14 -0
- package/useUnmount/useUnmount.d.ts.map +1 -0
- package/useUnmount/useUnmount.js +13 -0
- package/useWindowSize/index.d.ts +2 -0
- package/useWindowSize/index.d.ts.map +1 -0
- package/useWindowSize/index.js +4 -0
- package/useWindowSize/useWindowSize.d.ts +30 -0
- package/useWindowSize/useWindowSize.d.ts.map +1 -0
- package/useWindowSize/useWindowSize.js +31 -0
|
@@ -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,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
|
+
};
|