@os-design/use-safe-area-inset 1.0.16 → 1.0.17
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/package.json +13 -5
- package/src/index.ts +64 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@os-design/use-safe-area-inset",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.17",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"repository": "git@gitlab.com:os-team/libs/os-design.git",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
@@ -14,7 +14,15 @@
|
|
|
14
14
|
"./package.json": "./package.json"
|
|
15
15
|
},
|
|
16
16
|
"files": [
|
|
17
|
-
"dist"
|
|
17
|
+
"dist",
|
|
18
|
+
"src",
|
|
19
|
+
"!**/*.test.ts",
|
|
20
|
+
"!**/*.test.tsx",
|
|
21
|
+
"!**/__tests__",
|
|
22
|
+
"!**/*.stories.tsx",
|
|
23
|
+
"!**/*.stories.mdx",
|
|
24
|
+
"!**/*.example.tsx",
|
|
25
|
+
"!**/*.emotion.d.ts"
|
|
18
26
|
],
|
|
19
27
|
"sideEffects": false,
|
|
20
28
|
"scripts": {
|
|
@@ -29,11 +37,11 @@
|
|
|
29
37
|
"access": "public"
|
|
30
38
|
},
|
|
31
39
|
"dependencies": {
|
|
32
|
-
"@os-design/use-browser-layout-effect": "^1.0.
|
|
33
|
-
"@os-design/use-event": "^1.0.
|
|
40
|
+
"@os-design/use-browser-layout-effect": "^1.0.14",
|
|
41
|
+
"@os-design/use-event": "^1.0.14"
|
|
34
42
|
},
|
|
35
43
|
"peerDependencies": {
|
|
36
44
|
"react": ">=18"
|
|
37
45
|
},
|
|
38
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "3d6b264027712ef81a75379fe3fde3c76c3079af"
|
|
39
47
|
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import useBrowserLayoutEffect from '@os-design/use-browser-layout-effect';
|
|
2
|
+
import useEvent from '@os-design/use-event';
|
|
3
|
+
import { useCallback, useEffect, useRef, useState } from 'react';
|
|
4
|
+
|
|
5
|
+
interface UseSafeAreaInsetRes {
|
|
6
|
+
top: number;
|
|
7
|
+
right: number;
|
|
8
|
+
bottom: number;
|
|
9
|
+
left: number;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
const computeSafeAreaInset = () => {
|
|
13
|
+
const res = { top: 0, right: 0, bottom: 0, left: 0 };
|
|
14
|
+
// Get css properties
|
|
15
|
+
return Object.keys(res).reduce<UseSafeAreaInsetRes>((acc, cur) => {
|
|
16
|
+
const style = getComputedStyle(document.documentElement).getPropertyValue(
|
|
17
|
+
`--safe-area-inset-${cur}`
|
|
18
|
+
);
|
|
19
|
+
return { ...acc, [cur]: parseFloat(style) || 0 };
|
|
20
|
+
}, res);
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
const useSafeAreaInset = (): UseSafeAreaInsetRes => {
|
|
24
|
+
const [safeAreaInset, setSafeAreaInset] = useState<UseSafeAreaInsetRes>({
|
|
25
|
+
top: 0,
|
|
26
|
+
right: 0,
|
|
27
|
+
bottom: 0,
|
|
28
|
+
left: 0,
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
const updateSafeAreaInset = useCallback(() => {
|
|
32
|
+
const nextSafeAreaInset = computeSafeAreaInset();
|
|
33
|
+
if (JSON.stringify(safeAreaInset) === JSON.stringify(nextSafeAreaInset))
|
|
34
|
+
return;
|
|
35
|
+
setSafeAreaInset(nextSafeAreaInset);
|
|
36
|
+
}, [safeAreaInset]);
|
|
37
|
+
|
|
38
|
+
const updateSafeAreaInsetRef = useRef(updateSafeAreaInset);
|
|
39
|
+
useEffect(() => {
|
|
40
|
+
updateSafeAreaInsetRef.current = updateSafeAreaInset;
|
|
41
|
+
}, [updateSafeAreaInset]);
|
|
42
|
+
|
|
43
|
+
useBrowserLayoutEffect(() => {
|
|
44
|
+
// Set css properties
|
|
45
|
+
['top', 'right', 'bottom', 'left'].forEach((item) => {
|
|
46
|
+
document.documentElement.style.setProperty(
|
|
47
|
+
`--safe-area-inset-${item}`,
|
|
48
|
+
`env(safe-area-inset-${item})`
|
|
49
|
+
);
|
|
50
|
+
});
|
|
51
|
+
// Update initial values
|
|
52
|
+
updateSafeAreaInsetRef.current();
|
|
53
|
+
}, []);
|
|
54
|
+
|
|
55
|
+
useEvent(
|
|
56
|
+
(typeof window !== 'undefined' ? window : undefined) as EventTarget,
|
|
57
|
+
'scroll',
|
|
58
|
+
updateSafeAreaInset
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
return safeAreaInset;
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
export default useSafeAreaInset;
|