@os-design/use-size 1.0.19 → 1.0.21
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/index.js +2 -3
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/package.json +4 -4
- package/src/index.mdx +31 -0
package/dist/cjs/index.js
CHANGED
|
@@ -11,7 +11,7 @@ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArra
|
|
|
11
11
|
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
|
|
12
12
|
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
|
|
13
13
|
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
|
|
14
|
-
function _iterableToArrayLimit(
|
|
14
|
+
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
|
|
15
15
|
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
|
|
16
16
|
var useSize = function useSize(container) {
|
|
17
17
|
var _useState = (0, _react.useState)({
|
|
@@ -44,6 +44,5 @@ var useSize = function useSize(container) {
|
|
|
44
44
|
(0, _useEvent["default"])(typeof window !== 'undefined' ? window : undefined, 'resize', updateSize);
|
|
45
45
|
return size;
|
|
46
46
|
};
|
|
47
|
-
var _default = useSize;
|
|
48
|
-
exports["default"] = _default;
|
|
47
|
+
var _default = exports["default"] = useSize;
|
|
49
48
|
//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["_useEvent","_interopRequireDefault","require","_react","obj","__esModule","_slicedToArray","arr","i","_arrayWithHoles","_iterableToArrayLimit","_unsupportedIterableToArray","_nonIterableRest","TypeError","o","minLen","_arrayLikeToArray","n","Object","prototype","toString","call","slice","constructor","name","Array","from","test","len","length","arr2","
|
|
1
|
+
{"version":3,"file":"index.js","names":["_useEvent","_interopRequireDefault","require","_react","obj","__esModule","_slicedToArray","arr","i","_arrayWithHoles","_iterableToArrayLimit","_unsupportedIterableToArray","_nonIterableRest","TypeError","o","minLen","_arrayLikeToArray","n","Object","prototype","toString","call","slice","constructor","name","Array","from","test","len","length","arr2","r","l","t","Symbol","iterator","e","u","a","f","next","done","push","value","isArray","useSize","container","_useState","useState","width","height","_useState2","size","setSize","updateSize","useCallback","window","innerWidth","innerHeight","containerElement","Element","current","clientWidth","clientHeight","useEffect","useEvent","undefined","_default","exports"],"sources":["../../src/index.ts"],"sourcesContent":["import useEvent from '@os-design/use-event';\nimport { RefObject, useCallback, useEffect, useState } from 'react';\n\ninterface Size {\n width: number;\n height: number;\n}\n\nconst useSize = (container?: Element | RefObject<Element>): Size => {\n const [size, setSize] = useState<Size>({ width: 0, height: 0 });\n\n const updateSize = useCallback(() => {\n if (!container) {\n setSize({ width: window.innerWidth, height: window.innerHeight });\n return;\n }\n\n const containerElement =\n container instanceof Element ? container : container.current;\n if (!containerElement) return;\n\n setSize({\n width: containerElement.clientWidth,\n height: containerElement.clientHeight,\n });\n }, [container]);\n\n // Init the size of the container\n useEffect(() => {\n updateSize();\n }, [updateSize]);\n\n useEvent(\n (typeof window !== 'undefined' ? window : undefined) as never,\n 'resize',\n updateSize\n );\n\n return size;\n};\n\nexport default useSize;\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AAAoE,SAAAD,uBAAAG,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,gBAAAA,GAAA;AAAA,SAAAE,eAAAC,GAAA,EAAAC,CAAA,WAAAC,eAAA,CAAAF,GAAA,KAAAG,qBAAA,CAAAH,GAAA,EAAAC,CAAA,KAAAG,2BAAA,CAAAJ,GAAA,EAAAC,CAAA,KAAAI,gBAAA;AAAA,SAAAA,iBAAA,cAAAC,SAAA;AAAA,SAAAF,4BAAAG,CAAA,EAAAC,MAAA,SAAAD,CAAA,qBAAAA,CAAA,sBAAAE,iBAAA,CAAAF,CAAA,EAAAC,MAAA,OAAAE,CAAA,GAAAC,MAAA,CAAAC,SAAA,CAAAC,QAAA,CAAAC,IAAA,CAAAP,CAAA,EAAAQ,KAAA,aAAAL,CAAA,iBAAAH,CAAA,CAAAS,WAAA,EAAAN,CAAA,GAAAH,CAAA,CAAAS,WAAA,CAAAC,IAAA,MAAAP,CAAA,cAAAA,CAAA,mBAAAQ,KAAA,CAAAC,IAAA,CAAAZ,CAAA,OAAAG,CAAA,+DAAAU,IAAA,CAAAV,CAAA,UAAAD,iBAAA,CAAAF,CAAA,EAAAC,MAAA;AAAA,SAAAC,kBAAAT,GAAA,EAAAqB,GAAA,QAAAA,GAAA,YAAAA,GAAA,GAAArB,GAAA,CAAAsB,MAAA,EAAAD,GAAA,GAAArB,GAAA,CAAAsB,MAAA,WAAArB,CAAA,MAAAsB,IAAA,OAAAL,KAAA,CAAAG,GAAA,GAAApB,CAAA,GAAAoB,GAAA,EAAApB,CAAA,IAAAsB,IAAA,CAAAtB,CAAA,IAAAD,GAAA,CAAAC,CAAA,UAAAsB,IAAA;AAAA,SAAApB,sBAAAqB,CAAA,EAAAC,CAAA,QAAAC,CAAA,WAAAF,CAAA,gCAAAG,MAAA,IAAAH,CAAA,CAAAG,MAAA,CAAAC,QAAA,KAAAJ,CAAA,4BAAAE,CAAA,QAAAG,CAAA,EAAAnB,CAAA,EAAAT,CAAA,EAAA6B,CAAA,EAAAC,CAAA,OAAAC,CAAA,OAAAzB,CAAA,iBAAAN,CAAA,IAAAyB,CAAA,GAAAA,CAAA,CAAAZ,IAAA,CAAAU,CAAA,GAAAS,IAAA,QAAAR,CAAA,QAAAd,MAAA,CAAAe,CAAA,MAAAA,CAAA,UAAAM,CAAA,uBAAAA,CAAA,IAAAH,CAAA,GAAA5B,CAAA,CAAAa,IAAA,CAAAY,CAAA,GAAAQ,IAAA,MAAAH,CAAA,CAAAI,IAAA,CAAAN,CAAA,CAAAO,KAAA,GAAAL,CAAA,CAAAT,MAAA,KAAAG,CAAA,GAAAO,CAAA,iBAAAR,CAAA,IAAAjB,CAAA,OAAAG,CAAA,GAAAc,CAAA,yBAAAQ,CAAA,YAAAN,CAAA,eAAAI,CAAA,GAAAJ,CAAA,cAAAf,MAAA,CAAAmB,CAAA,MAAAA,CAAA,2BAAAvB,CAAA,QAAAG,CAAA,aAAAqB,CAAA;AAAA,SAAA7B,gBAAAF,GAAA,QAAAkB,KAAA,CAAAmB,OAAA,CAAArC,GAAA,UAAAA,GAAA;AAOpE,IAAMsC,OAAO,GAAG,SAAVA,OAAOA,CAAIC,SAAwC,EAAW;EAClE,IAAAC,SAAA,GAAwB,IAAAC,eAAQ,EAAO;MAAEC,KAAK,EAAE,CAAC;MAAEC,MAAM,EAAE;IAAE,CAAC,CAAC;IAAAC,UAAA,GAAA7C,cAAA,CAAAyC,SAAA;IAAxDK,IAAI,GAAAD,UAAA;IAAEE,OAAO,GAAAF,UAAA;EAEpB,IAAMG,UAAU,GAAG,IAAAC,kBAAW,EAAC,YAAM;IACnC,IAAI,CAACT,SAAS,EAAE;MACdO,OAAO,CAAC;QAAEJ,KAAK,EAAEO,MAAM,CAACC,UAAU;QAAEP,MAAM,EAAEM,MAAM,CAACE;MAAY,CAAC,CAAC;MACjE;IACF;IAEA,IAAMC,gBAAgB,GACpBb,SAAS,YAAYc,OAAO,GAAGd,SAAS,GAAGA,SAAS,CAACe,OAAO;IAC9D,IAAI,CAACF,gBAAgB,EAAE;IAEvBN,OAAO,CAAC;MACNJ,KAAK,EAAEU,gBAAgB,CAACG,WAAW;MACnCZ,MAAM,EAAES,gBAAgB,CAACI;IAC3B,CAAC,CAAC;EACJ,CAAC,EAAE,CAACjB,SAAS,CAAC,CAAC;;EAEf;EACA,IAAAkB,gBAAS,EAAC,YAAM;IACdV,UAAU,CAAC,CAAC;EACd,CAAC,EAAE,CAACA,UAAU,CAAC,CAAC;EAEhB,IAAAW,oBAAQ,EACL,OAAOT,MAAM,KAAK,WAAW,GAAGA,MAAM,GAAGU,SAAS,EACnD,QAAQ,EACRZ,UACF,CAAC;EAED,OAAOF,IAAI;AACb,CAAC;AAAC,IAAAe,QAAA,GAAAC,OAAA,cAEavB,OAAO","ignoreList":[]}
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["useEvent","useCallback","useEffect","useState","useSize","container","size","setSize","width","height","updateSize","window","innerWidth","innerHeight","containerElement","Element","current","clientWidth","clientHeight","undefined"],"sources":["../../src/index.ts"],"sourcesContent":["import useEvent from '@os-design/use-event';\nimport { RefObject, useCallback, useEffect, useState } from 'react';\n\ninterface Size {\n width: number;\n height: number;\n}\n\nconst useSize = (container?: Element | RefObject<Element>): Size => {\n const [size, setSize] = useState<Size>({ width: 0, height: 0 });\n\n const updateSize = useCallback(() => {\n if (!container) {\n setSize({ width: window.innerWidth, height: window.innerHeight });\n return;\n }\n\n const containerElement =\n container instanceof Element ? container : container.current;\n if (!containerElement) return;\n\n setSize({\n width: containerElement.clientWidth,\n height: containerElement.clientHeight,\n });\n }, [container]);\n\n // Init the size of the container\n useEffect(() => {\n updateSize();\n }, [updateSize]);\n\n useEvent(\n (typeof window !== 'undefined' ? window : undefined) as never,\n 'resize',\n updateSize\n );\n\n return size;\n};\n\nexport default useSize;\n"],"mappings":"AAAA,OAAOA,QAAQ,MAAM,sBAAsB;AAC3C,SAAoBC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AAOnE,MAAMC,OAAO,GAAIC,SAAwC,IAAW;EAClE,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGJ,QAAQ,CAAO;IAAEK,KAAK,EAAE,CAAC;IAAEC,MAAM,EAAE;EAAE,CAAC,CAAC;EAE/D,MAAMC,UAAU,GAAGT,WAAW,CAAC,MAAM;IACnC,IAAI,CAACI,SAAS,EAAE;MACdE,OAAO,CAAC;QAAEC,KAAK,EAAEG,MAAM,CAACC,UAAU;QAAEH,MAAM,EAAEE,MAAM,CAACE;MAAY,CAAC,CAAC;MACjE;IACF;IAEA,MAAMC,gBAAgB,GACpBT,SAAS,YAAYU,OAAO,GAAGV,SAAS,GAAGA,SAAS,CAACW,OAAO;IAC9D,IAAI,CAACF,gBAAgB,EAAE;IAEvBP,OAAO,CAAC;MACNC,KAAK,EAAEM,gBAAgB,CAACG,WAAW;MACnCR,MAAM,EAAEK,gBAAgB,CAACI;IAC3B,CAAC,CAAC;EACJ,CAAC,EAAE,CAACb,SAAS,CAAC,CAAC;;EAEf;EACAH,SAAS,CAAC,MAAM;IACdQ,UAAU,CAAC,CAAC;EACd,CAAC,EAAE,CAACA,UAAU,CAAC,CAAC;EAEhBV,QAAQ,CACL,OAAOW,MAAM,KAAK,WAAW,GAAGA,MAAM,GAAGQ,SAAS,EACnD,QAAQ,EACRT,UACF,CAAC;EAED,OAAOJ,IAAI;AACb,CAAC;AAED,eAAeF,OAAO"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["useEvent","useCallback","useEffect","useState","useSize","container","size","setSize","width","height","updateSize","window","innerWidth","innerHeight","containerElement","Element","current","clientWidth","clientHeight","undefined"],"sources":["../../src/index.ts"],"sourcesContent":["import useEvent from '@os-design/use-event';\nimport { RefObject, useCallback, useEffect, useState } from 'react';\n\ninterface Size {\n width: number;\n height: number;\n}\n\nconst useSize = (container?: Element | RefObject<Element>): Size => {\n const [size, setSize] = useState<Size>({ width: 0, height: 0 });\n\n const updateSize = useCallback(() => {\n if (!container) {\n setSize({ width: window.innerWidth, height: window.innerHeight });\n return;\n }\n\n const containerElement =\n container instanceof Element ? container : container.current;\n if (!containerElement) return;\n\n setSize({\n width: containerElement.clientWidth,\n height: containerElement.clientHeight,\n });\n }, [container]);\n\n // Init the size of the container\n useEffect(() => {\n updateSize();\n }, [updateSize]);\n\n useEvent(\n (typeof window !== 'undefined' ? window : undefined) as never,\n 'resize',\n updateSize\n );\n\n return size;\n};\n\nexport default useSize;\n"],"mappings":"AAAA,OAAOA,QAAQ,MAAM,sBAAsB;AAC3C,SAAoBC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AAOnE,MAAMC,OAAO,GAAIC,SAAwC,IAAW;EAClE,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGJ,QAAQ,CAAO;IAAEK,KAAK,EAAE,CAAC;IAAEC,MAAM,EAAE;EAAE,CAAC,CAAC;EAE/D,MAAMC,UAAU,GAAGT,WAAW,CAAC,MAAM;IACnC,IAAI,CAACI,SAAS,EAAE;MACdE,OAAO,CAAC;QAAEC,KAAK,EAAEG,MAAM,CAACC,UAAU;QAAEH,MAAM,EAAEE,MAAM,CAACE;MAAY,CAAC,CAAC;MACjE;IACF;IAEA,MAAMC,gBAAgB,GACpBT,SAAS,YAAYU,OAAO,GAAGV,SAAS,GAAGA,SAAS,CAACW,OAAO;IAC9D,IAAI,CAACF,gBAAgB,EAAE;IAEvBP,OAAO,CAAC;MACNC,KAAK,EAAEM,gBAAgB,CAACG,WAAW;MACnCR,MAAM,EAAEK,gBAAgB,CAACI;IAC3B,CAAC,CAAC;EACJ,CAAC,EAAE,CAACb,SAAS,CAAC,CAAC;;EAEf;EACAH,SAAS,CAAC,MAAM;IACdQ,UAAU,CAAC,CAAC;EACd,CAAC,EAAE,CAACA,UAAU,CAAC,CAAC;EAEhBV,QAAQ,CACL,OAAOW,MAAM,KAAK,WAAW,GAAGA,MAAM,GAAGQ,SAAS,EACnD,QAAQ,EACRT,UACF,CAAC;EAED,OAAOJ,IAAI;AACb,CAAC;AAED,eAAeF,OAAO","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@os-design/use-size",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.21",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"repository": "git@gitlab.com:os-team/libs/os-design.git",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
@@ -23,17 +23,17 @@
|
|
|
23
23
|
"build:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/esm --source-maps",
|
|
24
24
|
"build:cjs": "cross-env BABEL_ENV=cjs babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/cjs --source-maps",
|
|
25
25
|
"build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
|
|
26
|
-
"build": "yarn clean && npm-run-all build:*",
|
|
26
|
+
"build": "yarn clean && npm-run-all 'build:*'",
|
|
27
27
|
"ncu": "ncu -u"
|
|
28
28
|
},
|
|
29
29
|
"publishConfig": {
|
|
30
30
|
"access": "public"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@os-design/use-event": "^1.0.
|
|
33
|
+
"@os-design/use-event": "^1.0.20"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
36
|
"react": ">=18"
|
|
37
37
|
},
|
|
38
|
-
"gitHead": "
|
|
38
|
+
"gitHead": "1f17189e344a56fd6347dd6b896d6e7ef6e7b35d"
|
|
39
39
|
}
|
package/src/index.mdx
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
import UseSizeExample from './index.example';
|
|
3
|
+
|
|
4
|
+
<Meta title='Utils/useSize' />
|
|
5
|
+
|
|
6
|
+
# useSize
|
|
7
|
+
|
|
8
|
+
Returns the width and height of the container. By default, the container is window.
|
|
9
|
+
|
|
10
|
+
## Example of usage
|
|
11
|
+
|
|
12
|
+
```tsx
|
|
13
|
+
import React from 'react';
|
|
14
|
+
import { useSize } from '@os-design/utils';
|
|
15
|
+
|
|
16
|
+
const UseSizeExample: React.FC = () => {
|
|
17
|
+
const size = useSize();
|
|
18
|
+
|
|
19
|
+
return (
|
|
20
|
+
<p>
|
|
21
|
+
Size: {size.width}x{size.height}
|
|
22
|
+
</p>
|
|
23
|
+
);
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
export default UseSizeExample;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
<UseSizeExample />
|
|
30
|
+
|
|
31
|
+
Try resizing the browser window.
|