@1hook/use-size 0.0.1-beta.1 → 0.0.1

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/index.d.ts CHANGED
@@ -1,12 +1,41 @@
1
- type SetInit<T> = Iterable<T> | null | undefined;
2
- declare function useSet<T>(init?: SetInit<T>): Set<T> & {
3
- values(): T[];
4
- } & {
5
- add(value: T): void;
6
- clear(): void;
7
- delete(value: T): void;
8
- has(value: T): boolean;
9
- reset(init?: SetInit<T>): void;
1
+ import React from 'react';
2
+
3
+ type Size = {
4
+ /**
5
+ * The width of the element.
6
+ */
7
+ width?: number;
8
+ /**
9
+ * The height of the element.
10
+ */
11
+ height?: number;
12
+ };
13
+ type UseSizeOptions = {
14
+ /**
15
+ * Set to `false` to avoid tracking the state for better performance
16
+ *
17
+ * @default true
18
+ */
19
+ trackState?: boolean;
20
+ /**
21
+ * Called with `{ width, height }` when the ResizeObserver is triggered.
22
+ *
23
+ * `onChange` is executed even if `trackState` is `false`.
24
+ */
25
+ onChange?: (size: Size) => void;
26
+ };
27
+ type UseSizeReturn = Size & {
28
+ /**
29
+ * A callback ref to pass to the element to observe.
30
+ *
31
+ * @remarks `Function`
32
+ */
33
+ ref: React.Dispatch<React.SetStateAction<Element | null>>;
34
+ /**
35
+ * The observed element.
36
+ */
37
+ target: Element | null;
10
38
  };
39
+ declare function useSize({ trackState, onChange, }?: UseSizeOptions): UseSizeReturn;
11
40
 
12
- export { type SetInit, useSet };
41
+ export { type Size, type UseSizeOptions, type UseSizeReturn, useSize };
package/dist/index.js CHANGED
@@ -1,49 +1,31 @@
1
1
  import React from 'react';
2
+ import { useIsomorphicLayoutEffect } from '@1hook/use-isomorphic-layout-effect';
3
+ import { useEventHandler } from '@1hook/use-event-handler';
2
4
 
3
5
  // src/index.ts
4
- function useSet(init) {
5
- const [_set, _setSet] = React.useState(() => createSet(init));
6
- return Object.assign(
7
- _set,
8
- React.useMemo(
9
- () => ({
10
- add(value) {
11
- _setSet(
12
- (_set2) => _set2.has(value) ? _set2 : createSet([..._set2, value])
13
- );
14
- },
15
- clear() {
16
- _setSet(
17
- (_set2) => !_set2.size ? _set2 : createSet()
18
- );
19
- },
20
- delete(value) {
21
- _setSet(
22
- (_set2) => !_set2.has(value) ? _set2 : createSet([..._set2].filter((v) => v !== value))
23
- );
24
- },
25
- has(value) {
26
- return Set.prototype.has.call(_set, value);
27
- },
28
- reset(init2) {
29
- return _setSet(createSet(init2));
30
- }
31
- }),
32
- [_set]
33
- )
34
- );
35
- }
36
- function createSet(init) {
37
- const _set = new Set(init);
38
- let values;
39
- return Object.assign(_set, {
40
- values() {
41
- if (!values) values = [..._set];
42
- return values;
43
- }
44
- });
6
+ function useSize({
7
+ trackState = true,
8
+ onChange
9
+ } = {}) {
10
+ const [target, ref] = React.useState(null);
11
+ const [size, setSize] = React.useState({});
12
+ const handleChange = useEventHandler(onChange);
13
+ useIsomorphicLayoutEffect(() => {
14
+ if (!target) return;
15
+ const observer = new ResizeObserver((entries) => {
16
+ const { inlineSize: width, blockSize: height } = entries[0].borderBoxSize[0];
17
+ trackState && setSize({ width, height });
18
+ handleChange({ width, height });
19
+ });
20
+ observer.observe(target);
21
+ return () => {
22
+ setSize({});
23
+ observer.disconnect();
24
+ };
25
+ }, [handleChange, trackState, target]);
26
+ return { ...size, ref, target };
45
27
  }
46
28
 
47
- export { useSet };
29
+ export { useSize };
48
30
  //# sourceMappingURL=index.js.map
49
31
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"names":["_set","init"],"mappings":";;;AAIO,SAAS,OAAU,IAAmB,EAAA;AAC3C,EAAM,MAAA,CAAC,MAAM,OAAO,CAAA,GAAI,MAAM,QAAS,CAAA,MAAM,SAAU,CAAA,IAAI,CAAC,CAAA;AAI5D,EAAA,OAAO,MAAO,CAAA,MAAA;AAAA,IACZ,IAAA;AAAA,IACA,KAAM,CAAA,OAAA;AAAA,MACJ,OAAO;AAAA,QACL,IAAI,KAAgB,EAAA;AAClB,UAAA,OAAA;AAAA,YAAQ,CAACA,KAAAA,KACPA,KAAK,CAAA,GAAA,CAAI,KAAK,CAAA,GACVA,KACA,GAAA,SAAA,CAAU,CAAC,GAAGA,KAAM,EAAA,KAAK,CAAC;AAAA,WAChC;AAAA,SACF;AAAA,QACA,KAAc,GAAA;AACZ,UAAA,OAAA;AAAA,YAAQ,CAACA,KACP,KAAA,CAACA,KAAK,CAAA,IAAA,GACFA,QACA,SAAU;AAAA,WAChB;AAAA,SACF;AAAA,QACA,OAAO,KAAgB,EAAA;AACrB,UAAA,OAAA;AAAA,YAAQ,CAACA,KACP,KAAA,CAACA,MAAK,GAAI,CAAA,KAAK,IACXA,KACA,GAAA,SAAA,CAAU,CAAC,GAAGA,KAAI,CAAE,CAAA,MAAA,CAAO,CAAC,CAAM,KAAA,CAAA,KAAM,KAAK,CAAC;AAAA,WACpD;AAAA,SACF;AAAA,QACA,IAAI,KAAmB,EAAA;AACrB,UAAA,OAAO,GAAI,CAAA,SAAA,CAAU,GAAI,CAAA,IAAA,CAAK,MAAM,KAAK,CAAA;AAAA,SAC3C;AAAA,QACA,MAAMC,KAAyB,EAAA;AAC7B,UAAO,OAAA,OAAA,CAAQ,SAAUA,CAAAA,KAAI,CAAC,CAAA;AAAA;AAChC,OACF,CAAA;AAAA,MACA,CAAC,IAAI;AAAA;AACP,GACF;AACF;AAKA,SAAS,UAAa,IAAmB,EAAA;AACvC,EAAM,MAAA,IAAA,GAAO,IAAI,GAAA,CAAI,IAAI,CAAA;AACzB,EAAI,IAAA,MAAA;AACJ,EAAO,OAAA,MAAA,CAAO,OAAO,IAAM,EAAA;AAAA,IACzB,MAAS,GAAA;AAEP,MAAA,IAAI,CAAC,MAAA,EAAiB,MAAA,GAAA,CAAC,GAAG,IAAI,CAAA;AAC9B,MAAO,OAAA,MAAA;AAAA;AACT,GACD,CAAA;AACH","file":"index.js","sourcesContent":["import React from 'react'\n\nexport type SetInit<T> = Iterable<T> | null | undefined\n\nexport function useSet<T>(init?: SetInit<T>) {\n const [_set, _setSet] = React.useState(() => createSet(init))\n\n // by assigning to the _set, the result itself is spreadable, just like a Set\n // it also gives the result a stable identity\n return Object.assign(\n _set,\n React.useMemo(\n () => ({\n add(value: T): void {\n _setSet((_set) =>\n _set.has(value)\n ? _set // do not update the state if the value is already present\n : createSet([..._set, value]),\n )\n },\n clear(): void {\n _setSet((_set) =>\n !_set.size\n ? _set // do not update the state if the Set is already empty\n : createSet(),\n )\n },\n delete(value: T): void {\n _setSet((_set) =>\n !_set.has(value)\n ? _set // do not update the state if the value is already absent,\n : createSet([..._set].filter((v) => v !== value)),\n )\n },\n has(value: T): boolean {\n return Set.prototype.has.call(_set, value)\n },\n reset(init?: SetInit<T>): void {\n return _setSet(createSet(init))\n },\n }),\n [_set],\n ),\n )\n}\n\n/**\n * Memoize the values without pre-computing them\n */\nfunction createSet<T>(init?: SetInit<T>) {\n const _set = new Set(init)\n let values: T[]\n return Object.assign(_set, {\n values() {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (!values) values = [..._set]\n return values\n },\n })\n}\n"]}
1
+ {"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;AA2CO,SAAS,OAAQ,CAAA;AAAA,EACtB,UAAa,GAAA,IAAA;AAAA,EACb;AACF,CAAA,GAAoB,EAAmB,EAAA;AACrC,EAAA,MAAM,CAAC,MAAQ,EAAA,GAAG,CAAI,GAAA,KAAA,CAAM,SAAyB,IAAI,CAAA;AACzD,EAAA,MAAM,CAAC,IAAM,EAAA,OAAO,IAAI,KAAM,CAAA,QAAA,CAAe,EAAE,CAAA;AAC/C,EAAM,MAAA,YAAA,GAAe,gBAAgB,QAAQ,CAAA;AAI7C,EAAA,yBAAA,CAA0B,MAAM;AAC9B,IAAA,IAAI,CAAC,MAAQ,EAAA;AACb,IAAA,MAAM,QAAW,GAAA,IAAI,cAAe,CAAA,CAAC,OAAY,KAAA;AAC/C,MAAM,MAAA,EAAE,UAAY,EAAA,KAAA,EAAO,SAAW,EAAA,MAAA,KACpC,OAAQ,CAAA,CAAC,CAAG,CAAA,aAAA,CAAc,CAAC,CAAA;AAC7B,MAAA,UAAA,IAAc,OAAQ,CAAA,EAAE,KAAO,EAAA,MAAA,EAAQ,CAAA;AACvC,MAAa,YAAA,CAAA,EAAE,KAAO,EAAA,MAAA,EAAQ,CAAA;AAAA,KAC/B,CAAA;AACD,IAAA,QAAA,CAAS,QAAQ,MAAM,CAAA;AACvB,IAAA,OAAO,MAAM;AACX,MAAA,OAAA,CAAQ,EAAE,CAAA;AACV,MAAA,QAAA,CAAS,UAAW,EAAA;AAAA,KACtB;AAAA,GACC,EAAA,CAAC,YAAc,EAAA,UAAA,EAAY,MAAM,CAAC,CAAA;AAErC,EAAA,OAAO,EAAE,GAAG,IAAM,EAAA,GAAA,EAAK,MAAO,EAAA;AAChC","file":"index.js","sourcesContent":["import React from 'react'\nimport { useIsomorphicLayoutEffect } from '@1hook/use-isomorphic-layout-effect'\nimport { useEventHandler } from '@1hook/use-event-handler'\n\nexport type Size = {\n /**\n * The width of the element.\n */\n width?: number\n /**\n * The height of the element.\n */\n height?: number\n}\n\nexport type UseSizeOptions = {\n /**\n * Set to `false` to avoid tracking the state for better performance\n *\n * @default true\n */\n trackState?: boolean\n /**\n * Called with `{ width, height }` when the ResizeObserver is triggered.\n *\n * `onChange` is executed even if `trackState` is `false`.\n */\n onChange?: (size: Size) => void\n}\n\nexport type UseSizeReturn = Size & {\n /**\n * A callback ref to pass to the element to observe.\n *\n * @remarks `Function`\n */\n ref: React.Dispatch<React.SetStateAction<Element | null>>\n /**\n * The observed element.\n */\n target: Element | null\n}\n\nexport function useSize({\n trackState = true,\n onChange,\n}: UseSizeOptions = {}): UseSizeReturn {\n const [target, ref] = React.useState<Element | null>(null)\n const [size, setSize] = React.useState<Size>({})\n const handleChange = useEventHandler(onChange)\n\n // Since the use case is basic, in order to reduce the bundle size\n // we use ResizeObserver instead of useResizeObserver\n useIsomorphicLayoutEffect(() => {\n if (!target) return\n const observer = new ResizeObserver((entries) => {\n const { inlineSize: width, blockSize: height } =\n entries[0]!.borderBoxSize[0]!\n trackState && setSize({ width, height })\n handleChange({ width, height })\n })\n observer.observe(target)\n return () => {\n setSize({})\n observer.disconnect()\n }\n }, [handleChange, trackState, target])\n\n return { ...size, ref, target }\n}\n"]}
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@1hook/use-size",
3
- "version": "0.0.1-beta.1",
3
+ "version": "0.0.1",
4
4
  "files": [
5
5
  "dist",
6
6
  "README.md"
@@ -19,7 +19,27 @@
19
19
  "react": ">=18.0.0 || >=19.0.0",
20
20
  "react-dom": ">=18.0.0 || >=19.0.0"
21
21
  },
22
+ "dependencies": {
23
+ "@1hook/use-event-handler": "0.0.1",
24
+ "@1hook/use-isomorphic-layout-effect": "0.0.1"
25
+ },
22
26
  "tag": "beta",
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "https://github.com/L-Blondy/one-hook"
30
+ },
31
+ "homepage": "https://github.com/L-Blondy/one-hook",
32
+ "bugs": {
33
+ "url": "https://github.com/L-Blondy/one-hook/issues"
34
+ },
35
+ "peerDependenciesMeta": {
36
+ "@types/react": {
37
+ "optional": true
38
+ },
39
+ "@types/react-dom": {
40
+ "optional": true
41
+ }
42
+ },
23
43
  "scripts": {
24
44
  "build": "NODE_ENV=production tsup",
25
45
  "dev": "concurrently \"tsup --watch\" \"vitest\"",