@spark-ui/hooks 11.1.0 → 11.1.2
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 +8 -0
- package/dist/use-combined-state/index.d.ts +12 -0
- package/dist/use-combined-state/index.js +62 -0
- package/dist/use-combined-state/index.js.map +1 -0
- package/dist/use-merge-refs/index.d.ts +7 -0
- package/dist/use-merge-refs/index.js +60 -0
- package/dist/use-merge-refs/index.js.map +1 -0
- package/dist/use-mounted-state/index.d.ts +3 -0
- package/dist/use-mounted-state/index.js +44 -0
- package/dist/use-mounted-state/index.js.map +1 -0
- package/dist/use-scroll-overflow/index.d.ts +18 -0
- package/dist/use-scroll-overflow/index.js +73 -0
- package/dist/use-scroll-overflow/index.js.map +1 -0
- package/package.json +2 -2
- package/tsup.config.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [11.1.2](https://github.com/leboncoin/spark-web/compare/v11.1.1...v11.1.2) (2025-10-31)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @spark-ui/hooks
|
|
9
|
+
|
|
10
|
+
## [11.1.1](https://github.com/leboncoin/spark-web/compare/v11.1.0...v11.1.1) (2025-10-30)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @spark-ui/hooks
|
|
13
|
+
|
|
6
14
|
# [11.1.0](https://github.com/leboncoin/spark-web/compare/v11.0.1...v11.1.0) (2025-10-29)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @spark-ui/hooks
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This hook must be used when a component has both a controlled and uncontrolled mode.
|
|
3
|
+
* It will take care of updating the state value when a controlled mode (prop) is updated.
|
|
4
|
+
*/
|
|
5
|
+
declare function useCombinedState<T>(controlledValue?: T, defaultValue?: T, onChange?: (nextValue: T) => void): [
|
|
6
|
+
T | undefined,
|
|
7
|
+
(newValue: T, forceFlag?: (prev: T, next: T) => boolean) => void,
|
|
8
|
+
boolean,
|
|
9
|
+
T | undefined
|
|
10
|
+
];
|
|
11
|
+
|
|
12
|
+
export { useCombinedState };
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
|
|
30
|
+
// src/use-combined-state/index.ts
|
|
31
|
+
var use_combined_state_exports = {};
|
|
32
|
+
__export(use_combined_state_exports, {
|
|
33
|
+
useCombinedState: () => useCombinedState
|
|
34
|
+
});
|
|
35
|
+
module.exports = __toCommonJS(use_combined_state_exports);
|
|
36
|
+
|
|
37
|
+
// src/use-combined-state/useCombinedState.tsx
|
|
38
|
+
var import_lodash = __toESM(require("lodash.isequal"));
|
|
39
|
+
var import_react = require("react");
|
|
40
|
+
function useCombinedState(controlledValue, defaultValue, onChange) {
|
|
41
|
+
const isControlled = controlledValue !== void 0;
|
|
42
|
+
const { current: initialValue } = (0, import_react.useRef)(isControlled ? controlledValue : defaultValue);
|
|
43
|
+
const [innerValue, setInnerValue] = (0, import_react.useState)(defaultValue);
|
|
44
|
+
const value = isControlled ? controlledValue : innerValue;
|
|
45
|
+
const updater = (0, import_react.useCallback)(
|
|
46
|
+
(next, shouldUpdateProp = (prevValue, nextValue) => !(0, import_lodash.default)(prevValue, nextValue)) => {
|
|
47
|
+
const nextValue = typeof next !== "function" ? next : next(value);
|
|
48
|
+
const shouldUpdate = shouldUpdateProp(value, nextValue);
|
|
49
|
+
if (shouldUpdate && !isControlled) {
|
|
50
|
+
setInnerValue(nextValue);
|
|
51
|
+
}
|
|
52
|
+
onChange && onChange(nextValue);
|
|
53
|
+
},
|
|
54
|
+
[isControlled, value, onChange]
|
|
55
|
+
);
|
|
56
|
+
return [value, updater, isControlled, initialValue];
|
|
57
|
+
}
|
|
58
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
59
|
+
0 && (module.exports = {
|
|
60
|
+
useCombinedState
|
|
61
|
+
});
|
|
62
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/use-combined-state/index.ts","../../src/use-combined-state/useCombinedState.tsx"],"sourcesContent":["export { useCombinedState } from './useCombinedState'\n","import isEqual from 'lodash.isequal'\nimport { SetStateAction, useCallback, useRef, useState } from 'react'\n\n/**\n * This hook must be used when a component has both a controlled and uncontrolled mode.\n * It will take care of updating the state value when a controlled mode (prop) is updated.\n */\nexport function useCombinedState<T>(\n controlledValue?: T,\n defaultValue?: T,\n onChange?: (nextValue: T) => void\n): [\n T | undefined,\n (newValue: T, forceFlag?: (prev: T, next: T) => boolean) => void,\n boolean,\n T | undefined,\n] {\n const isControlled = controlledValue !== undefined\n const { current: initialValue } = useRef(isControlled ? controlledValue : defaultValue)\n\n const [innerValue, setInnerValue] = useState(defaultValue as T)\n const value = isControlled ? (controlledValue as T) : innerValue\n\n const updater = useCallback(\n (\n next: SetStateAction<T>,\n shouldUpdateProp = (prevValue: T, nextValue: T) => !isEqual(prevValue, nextValue)\n ) => {\n const nextValue = typeof next !== 'function' ? next : (next as (value: T) => T)(value)\n const shouldUpdate = shouldUpdateProp(value, nextValue)\n if (shouldUpdate && !isControlled) {\n setInnerValue(nextValue)\n }\n onChange && onChange(nextValue)\n },\n [isControlled, value, onChange]\n )\n\n return [value, updater, isControlled, initialValue]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAoB;AACpB,mBAA8D;AAMvD,SAAS,iBACd,iBACA,cACA,UAMA;AACA,QAAM,eAAe,oBAAoB;AACzC,QAAM,EAAE,SAAS,aAAa,QAAI,qBAAO,eAAe,kBAAkB,YAAY;AAEtF,QAAM,CAAC,YAAY,aAAa,QAAI,uBAAS,YAAiB;AAC9D,QAAM,QAAQ,eAAgB,kBAAwB;AAEtD,QAAM,cAAU;AAAA,IACd,CACE,MACA,mBAAmB,CAAC,WAAc,cAAiB,KAAC,cAAAA,SAAQ,WAAW,SAAS,MAC7E;AACH,YAAM,YAAY,OAAO,SAAS,aAAa,OAAQ,KAAyB,KAAK;AACrF,YAAM,eAAe,iBAAiB,OAAO,SAAS;AACtD,UAAI,gBAAgB,CAAC,cAAc;AACjC,sBAAc,SAAS;AAAA,MACzB;AACA,kBAAY,SAAS,SAAS;AAAA,IAChC;AAAA,IACA,CAAC,cAAc,OAAO,QAAQ;AAAA,EAChC;AAEA,SAAO,CAAC,OAAO,SAAS,cAAc,YAAY;AACpD;","names":["isEqual"]}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Ref, RefCallback } from 'react';
|
|
2
|
+
|
|
3
|
+
declare function assignRef<T>(ref: Ref<T> | null | undefined, value: T): void;
|
|
4
|
+
declare function mergeRefs<T>(...refs: (Ref<T> | undefined)[]): RefCallback<T>;
|
|
5
|
+
declare function useMergeRefs<T>(...refs: (Ref<T> | undefined)[]): RefCallback<T>;
|
|
6
|
+
|
|
7
|
+
export { assignRef, mergeRefs, useMergeRefs };
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/use-merge-refs/index.ts
|
|
21
|
+
var use_merge_refs_exports = {};
|
|
22
|
+
__export(use_merge_refs_exports, {
|
|
23
|
+
assignRef: () => assignRef,
|
|
24
|
+
mergeRefs: () => mergeRefs,
|
|
25
|
+
useMergeRefs: () => useMergeRefs
|
|
26
|
+
});
|
|
27
|
+
module.exports = __toCommonJS(use_merge_refs_exports);
|
|
28
|
+
|
|
29
|
+
// src/use-merge-refs/useMergeRefs.tsx
|
|
30
|
+
var import_react = require("react");
|
|
31
|
+
function assignRef(ref, value) {
|
|
32
|
+
if (ref == null) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
if (typeof ref === "function") {
|
|
36
|
+
ref(value);
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
try {
|
|
40
|
+
;
|
|
41
|
+
ref.current = value;
|
|
42
|
+
} catch {
|
|
43
|
+
throw new Error(`Cannot assign value '${value}' to ref '${ref}'`);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
function mergeRefs(...refs) {
|
|
47
|
+
return (value) => {
|
|
48
|
+
refs.forEach((ref) => assignRef(ref, value));
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function useMergeRefs(...refs) {
|
|
52
|
+
return (0, import_react.useMemo)(() => mergeRefs(...refs), refs);
|
|
53
|
+
}
|
|
54
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
55
|
+
0 && (module.exports = {
|
|
56
|
+
assignRef,
|
|
57
|
+
mergeRefs,
|
|
58
|
+
useMergeRefs
|
|
59
|
+
});
|
|
60
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/use-merge-refs/index.ts","../../src/use-merge-refs/useMergeRefs.tsx"],"sourcesContent":["export { useMergeRefs, assignRef, mergeRefs } from './useMergeRefs'\n","import { Ref, RefCallback, RefObject, useMemo } from 'react'\n\nexport function assignRef<T>(ref: Ref<T> | null | undefined, value: T) {\n if (ref == null) {\n return\n }\n\n if (typeof ref === 'function') {\n ref(value)\n\n return\n }\n\n try {\n ;(ref as RefObject<T | null>).current = value\n } catch {\n throw new Error(`Cannot assign value '${value}' to ref '${ref}'`)\n }\n}\n\nexport function mergeRefs<T>(...refs: (Ref<T> | undefined)[]): RefCallback<T> {\n return value => {\n refs.forEach(ref => assignRef(ref, value))\n }\n}\n\nexport function useMergeRefs<T>(...refs: (Ref<T> | undefined)[]) {\n // eslint-disable-next-line react-hooks/exhaustive-deps\n return useMemo(() => mergeRefs(...refs), refs)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAqD;AAE9C,SAAS,UAAa,KAAgC,OAAU;AACrE,MAAI,OAAO,MAAM;AACf;AAAA,EACF;AAEA,MAAI,OAAO,QAAQ,YAAY;AAC7B,QAAI,KAAK;AAET;AAAA,EACF;AAEA,MAAI;AACF;AAAC,IAAC,IAA4B,UAAU;AAAA,EAC1C,QAAQ;AACN,UAAM,IAAI,MAAM,wBAAwB,KAAK,aAAa,GAAG,GAAG;AAAA,EAClE;AACF;AAEO,SAAS,aAAgB,MAA8C;AAC5E,SAAO,WAAS;AACd,SAAK,QAAQ,SAAO,UAAU,KAAK,KAAK,CAAC;AAAA,EAC3C;AACF;AAEO,SAAS,gBAAmB,MAA8B;AAE/D,aAAO,sBAAQ,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI;AAC/C;","names":[]}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/use-mounted-state/index.ts
|
|
21
|
+
var use_mounted_state_exports = {};
|
|
22
|
+
__export(use_mounted_state_exports, {
|
|
23
|
+
useMountedState: () => useMountedState
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(use_mounted_state_exports);
|
|
26
|
+
|
|
27
|
+
// src/use-mounted-state/useMountedState.tsx
|
|
28
|
+
var import_react = require("react");
|
|
29
|
+
function useMountedState() {
|
|
30
|
+
const mountedRef = (0, import_react.useRef)(false);
|
|
31
|
+
const get = (0, import_react.useCallback)(() => mountedRef.current, []);
|
|
32
|
+
(0, import_react.useEffect)(() => {
|
|
33
|
+
mountedRef.current = true;
|
|
34
|
+
return () => {
|
|
35
|
+
mountedRef.current = false;
|
|
36
|
+
};
|
|
37
|
+
}, []);
|
|
38
|
+
return get;
|
|
39
|
+
}
|
|
40
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
41
|
+
0 && (module.exports = {
|
|
42
|
+
useMountedState
|
|
43
|
+
});
|
|
44
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/use-mounted-state/index.ts","../../src/use-mounted-state/useMountedState.tsx"],"sourcesContent":["export { useMountedState } from './useMountedState'\n","import { useCallback, useEffect, useRef } from 'react'\n\nexport function useMountedState(): () => boolean {\n const mountedRef = useRef(false)\n const get = useCallback(() => mountedRef.current, [])\n\n useEffect(() => {\n mountedRef.current = true\n\n return () => {\n mountedRef.current = false\n }\n }, [])\n\n return get\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA+C;AAExC,SAAS,kBAAiC;AAC/C,QAAM,iBAAa,qBAAO,KAAK;AAC/B,QAAM,UAAM,0BAAY,MAAM,WAAW,SAAS,CAAC,CAAC;AAEpD,8BAAU,MAAM;AACd,eAAW,UAAU;AAErB,WAAO,MAAM;AACX,iBAAW,UAAU;AAAA,IACvB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO;AACT;","names":[]}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { RefObject } from 'react';
|
|
2
|
+
|
|
3
|
+
interface ScrollOverflow {
|
|
4
|
+
top: number;
|
|
5
|
+
bottom: number;
|
|
6
|
+
left: number;
|
|
7
|
+
right: number;
|
|
8
|
+
}
|
|
9
|
+
declare function useScrollOverflow(scrollRef: RefObject<HTMLElement | null>,
|
|
10
|
+
/**
|
|
11
|
+
* Tolerance threshold for floating-point precision issues.
|
|
12
|
+
* Values below this threshold are considered as "no overflow" to handle sub-pixel rendering artifacts.
|
|
13
|
+
*/
|
|
14
|
+
{ precisionTreshold }?: {
|
|
15
|
+
precisionTreshold?: number;
|
|
16
|
+
}): ScrollOverflow;
|
|
17
|
+
|
|
18
|
+
export { type ScrollOverflow, useScrollOverflow };
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/use-scroll-overflow/index.ts
|
|
21
|
+
var use_scroll_overflow_exports = {};
|
|
22
|
+
__export(use_scroll_overflow_exports, {
|
|
23
|
+
useScrollOverflow: () => useScrollOverflow
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(use_scroll_overflow_exports);
|
|
26
|
+
|
|
27
|
+
// src/use-scroll-overflow/useScrollOverflow.tsx
|
|
28
|
+
var import_react = require("react");
|
|
29
|
+
function useScrollOverflow(scrollRef, { precisionTreshold = 0 } = {}) {
|
|
30
|
+
const [overflow, setOverflow] = (0, import_react.useState)({
|
|
31
|
+
top: 0,
|
|
32
|
+
bottom: 0,
|
|
33
|
+
left: 0,
|
|
34
|
+
right: 0
|
|
35
|
+
});
|
|
36
|
+
(0, import_react.useEffect)(() => {
|
|
37
|
+
const checkScrollContent = () => {
|
|
38
|
+
const scrollElement2 = scrollRef.current;
|
|
39
|
+
if (scrollElement2) {
|
|
40
|
+
const { scrollTop, scrollHeight, clientHeight, scrollLeft, scrollWidth, clientWidth } = scrollElement2;
|
|
41
|
+
const applyPrecision = (value) => {
|
|
42
|
+
return value <= precisionTreshold ? 0 : value;
|
|
43
|
+
};
|
|
44
|
+
const rightOverflow = scrollWidth - (scrollLeft + clientWidth);
|
|
45
|
+
const bottomOverflow = scrollHeight - (scrollTop + clientHeight);
|
|
46
|
+
setOverflow({
|
|
47
|
+
top: applyPrecision(scrollTop),
|
|
48
|
+
bottom: applyPrecision(bottomOverflow),
|
|
49
|
+
left: applyPrecision(scrollLeft),
|
|
50
|
+
right: applyPrecision(rightOverflow)
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
checkScrollContent();
|
|
55
|
+
const scrollElement = scrollRef.current;
|
|
56
|
+
if (scrollElement) {
|
|
57
|
+
scrollElement.addEventListener("scroll", checkScrollContent);
|
|
58
|
+
window.addEventListener("resize", checkScrollContent);
|
|
59
|
+
}
|
|
60
|
+
return () => {
|
|
61
|
+
if (scrollElement) {
|
|
62
|
+
scrollElement.removeEventListener("scroll", checkScrollContent);
|
|
63
|
+
window.removeEventListener("resize", checkScrollContent);
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
}, [scrollRef]);
|
|
67
|
+
return overflow;
|
|
68
|
+
}
|
|
69
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
70
|
+
0 && (module.exports = {
|
|
71
|
+
useScrollOverflow
|
|
72
|
+
});
|
|
73
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/use-scroll-overflow/index.ts","../../src/use-scroll-overflow/useScrollOverflow.tsx"],"sourcesContent":["export { useScrollOverflow } from './useScrollOverflow'\n\nexport type { ScrollOverflow } from './useScrollOverflow'\n","import { RefObject, useEffect, useState } from 'react'\n\nexport interface ScrollOverflow {\n top: number\n bottom: number\n left: number\n right: number\n}\n\nexport function useScrollOverflow(\n scrollRef: RefObject<HTMLElement | null>,\n /**\n * Tolerance threshold for floating-point precision issues.\n * Values below this threshold are considered as \"no overflow\" to handle sub-pixel rendering artifacts.\n */\n { precisionTreshold = 0 }: { precisionTreshold?: number } = {}\n): ScrollOverflow {\n const [overflow, setOverflow] = useState<ScrollOverflow>({\n top: 0,\n bottom: 0,\n left: 0,\n right: 0,\n })\n\n useEffect(() => {\n const checkScrollContent = () => {\n const scrollElement = scrollRef.current\n\n if (scrollElement) {\n const { scrollTop, scrollHeight, clientHeight, scrollLeft, scrollWidth, clientWidth } =\n scrollElement\n\n const applyPrecision = (value: number): number => {\n return value <= precisionTreshold ? 0 : value\n }\n\n const rightOverflow = scrollWidth - (scrollLeft + clientWidth)\n const bottomOverflow = scrollHeight - (scrollTop + clientHeight)\n\n setOverflow({\n top: applyPrecision(scrollTop),\n bottom: applyPrecision(bottomOverflow),\n left: applyPrecision(scrollLeft),\n right: applyPrecision(rightOverflow),\n })\n }\n }\n\n checkScrollContent()\n\n const scrollElement = scrollRef.current\n if (scrollElement) {\n scrollElement.addEventListener('scroll', checkScrollContent)\n window.addEventListener('resize', checkScrollContent)\n }\n\n return () => {\n if (scrollElement) {\n scrollElement.removeEventListener('scroll', checkScrollContent)\n window.removeEventListener('resize', checkScrollContent)\n }\n }\n }, [scrollRef])\n\n return overflow\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA+C;AASxC,SAAS,kBACd,WAKA,EAAE,oBAAoB,EAAE,IAAoC,CAAC,GAC7C;AAChB,QAAM,CAAC,UAAU,WAAW,QAAI,uBAAyB;AAAA,IACvD,KAAK;AAAA,IACL,QAAQ;AAAA,IACR,MAAM;AAAA,IACN,OAAO;AAAA,EACT,CAAC;AAED,8BAAU,MAAM;AACd,UAAM,qBAAqB,MAAM;AAC/B,YAAMA,iBAAgB,UAAU;AAEhC,UAAIA,gBAAe;AACjB,cAAM,EAAE,WAAW,cAAc,cAAc,YAAY,aAAa,YAAY,IAClFA;AAEF,cAAM,iBAAiB,CAAC,UAA0B;AAChD,iBAAO,SAAS,oBAAoB,IAAI;AAAA,QAC1C;AAEA,cAAM,gBAAgB,eAAe,aAAa;AAClD,cAAM,iBAAiB,gBAAgB,YAAY;AAEnD,oBAAY;AAAA,UACV,KAAK,eAAe,SAAS;AAAA,UAC7B,QAAQ,eAAe,cAAc;AAAA,UACrC,MAAM,eAAe,UAAU;AAAA,UAC/B,OAAO,eAAe,aAAa;AAAA,QACrC,CAAC;AAAA,MACH;AAAA,IACF;AAEA,uBAAmB;AAEnB,UAAM,gBAAgB,UAAU;AAChC,QAAI,eAAe;AACjB,oBAAc,iBAAiB,UAAU,kBAAkB;AAC3D,aAAO,iBAAiB,UAAU,kBAAkB;AAAA,IACtD;AAEA,WAAO,MAAM;AACX,UAAI,eAAe;AACjB,sBAAc,oBAAoB,UAAU,kBAAkB;AAC9D,eAAO,oBAAoB,UAAU,kBAAkB;AAAA,MACzD;AAAA,IACF;AAAA,EACF,GAAG,CAAC,SAAS,CAAC;AAEd,SAAO;AACT;","names":["scrollElement"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spark-ui/hooks",
|
|
3
|
-
"version": "11.1.
|
|
3
|
+
"version": "11.1.2",
|
|
4
4
|
"description": "Common hooks for Spark UI",
|
|
5
5
|
"exports": {
|
|
6
6
|
"./*": {
|
|
@@ -49,5 +49,5 @@
|
|
|
49
49
|
},
|
|
50
50
|
"homepage": "https://sparkui.vercel.app",
|
|
51
51
|
"license": "MIT",
|
|
52
|
-
"gitHead": "
|
|
52
|
+
"gitHead": "66cc5f71af5198553d00742b71847d85e4119a40"
|
|
53
53
|
}
|