@siberiacancode/reactuse 0.3.8 → 0.3.10
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/dist/cjs/hooks/useDebounceEffect/useDebounceEffect.cjs +2 -0
- package/dist/cjs/hooks/useDebounceEffect/useDebounceEffect.cjs.map +1 -0
- package/dist/cjs/hooks/useDidUpdate/useDidUpdate.cjs.map +1 -1
- package/dist/cjs/hooks/useSize/useSize.cjs +2 -0
- package/dist/cjs/hooks/useSize/useSize.cjs.map +1 -0
- package/dist/cjs/hooks/useThrottleEffect/useThrottleEffect.cjs +2 -0
- package/dist/cjs/hooks/useThrottleEffect/useThrottleEffect.cjs.map +1 -0
- package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs +1 -1
- package/dist/cjs/hooks/useUrlSearchParams/useUrlSearchParams.cjs.map +1 -1
- package/dist/cjs/hooks/useVisibility/useVisibility.cjs +1 -1
- package/dist/cjs/hooks/useVisibility/useVisibility.cjs.map +1 -1
- package/dist/cjs/index.cjs +1 -1
- package/dist/esm/hooks/useDebounceEffect/useDebounceEffect.mjs +19 -0
- package/dist/esm/hooks/useDebounceEffect/useDebounceEffect.mjs.map +1 -0
- package/dist/esm/hooks/useDidUpdate/useDidUpdate.mjs +7 -7
- package/dist/esm/hooks/useDidUpdate/useDidUpdate.mjs.map +1 -1
- package/dist/esm/hooks/useSize/useSize.mjs +31 -0
- package/dist/esm/hooks/useSize/useSize.mjs.map +1 -0
- package/dist/esm/hooks/useThrottleEffect/useThrottleEffect.mjs +22 -0
- package/dist/esm/hooks/useThrottleEffect/useThrottleEffect.mjs.map +1 -0
- package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs +6 -6
- package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs.map +1 -1
- package/dist/esm/hooks/useVisibility/useVisibility.mjs +22 -22
- package/dist/esm/hooks/useVisibility/useVisibility.mjs.map +1 -1
- package/dist/esm/index.mjs +100 -96
- package/dist/esm/index.mjs.map +1 -1
- package/dist/types/hooks/sensors.d.ts +1 -1
- package/dist/types/hooks/useDebounceEffect/useDebounceEffect.d.ts +15 -0
- package/dist/types/hooks/useSize/useSize.d.ts +43 -0
- package/dist/types/hooks/useThrottleEffect/useThrottleEffect.d.ts +15 -0
- package/dist/types/hooks/useVisibility/useVisibility.d.ts +1 -1
- package/dist/types/hooks/utilities.d.ts +2 -0
- package/package.json +1 -1
- package/dist/cjs/hooks/useElementSize/useElementSize.cjs +0 -2
- package/dist/cjs/hooks/useElementSize/useElementSize.cjs.map +0 -1
- package/dist/esm/hooks/useElementSize/useElementSize.mjs +0 -30
- package/dist/esm/hooks/useElementSize/useElementSize.mjs.map +0 -1
- package/dist/types/hooks/useElementSize/useElementSize.d.ts +0 -39
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import { HookTarget } from '../../utils/helpers';
|
|
2
|
-
import { StateRef } from '../useRefState/useRefState';
|
|
3
|
-
/** The element size value type */
|
|
4
|
-
export interface UseElementSizeValue {
|
|
5
|
-
/** The element's height */
|
|
6
|
-
height: number;
|
|
7
|
-
/** The element's width */
|
|
8
|
-
width: number;
|
|
9
|
-
}
|
|
10
|
-
/** The use element size return type */
|
|
11
|
-
export interface UseElementSizeReturn {
|
|
12
|
-
value: UseElementSizeValue;
|
|
13
|
-
}
|
|
14
|
-
export interface UseElementSize {
|
|
15
|
-
(target: HookTarget): UseElementSizeReturn;
|
|
16
|
-
<Target extends Element>(target?: never): {
|
|
17
|
-
ref: StateRef<Target>;
|
|
18
|
-
} & UseElementSizeReturn;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* @name useElementSize
|
|
22
|
-
* @description - Hook that observes and returns the width and height of element
|
|
23
|
-
* @category Elements
|
|
24
|
-
* @usage low
|
|
25
|
-
|
|
26
|
-
* @overload
|
|
27
|
-
* @param {HookTarget} target The target element to observe
|
|
28
|
-
* @returns {UseElementSizeReturn} An object containing the current width and height of the element
|
|
29
|
-
*
|
|
30
|
-
* @example
|
|
31
|
-
* const { value } = useElementSize(ref);
|
|
32
|
-
*
|
|
33
|
-
* @overload
|
|
34
|
-
* @returns { { ref: StateRef<Target> } & UseElementSizeReturn } An object containing the current width and height of the element
|
|
35
|
-
*
|
|
36
|
-
* @example
|
|
37
|
-
* const { ref, value } = useElementSize();
|
|
38
|
-
*/
|
|
39
|
-
export declare const useElementSize: UseElementSize;
|