@os-design/use-forwarded-state 1.0.21 → 1.0.22
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/dist/types/index.d.ts +4 -1
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/index.mdx +54 -0
package/dist/cjs/index.js
CHANGED
|
@@ -9,7 +9,7 @@ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArra
|
|
|
9
9
|
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."); }
|
|
10
10
|
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); }
|
|
11
11
|
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; }
|
|
12
|
-
function _iterableToArrayLimit(
|
|
12
|
+
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; } }
|
|
13
13
|
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
|
|
14
14
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
|
|
15
15
|
var isFunction = function isFunction(value) {
|
|
@@ -40,6 +40,5 @@ var useForwardedState = function useForwardedState(_ref) {
|
|
|
40
40
|
}, [forwardedValue, shouldUseInnerValue]);
|
|
41
41
|
return [forwardedValue, setForwardedValue];
|
|
42
42
|
};
|
|
43
|
-
var _default = useForwardedState;
|
|
44
|
-
exports["default"] = _default;
|
|
43
|
+
var _default = exports["default"] = useForwardedState;
|
|
45
44
|
//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["_react","require","_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":["_react","require","_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","isFunction","useForwardedState","_ref","defaultValue","onChange","_useState","useState","_useState2","innerValue","setInnerValue","onChangeRef","useRef","useEffect","current","shouldUseInnerValue","useMemo","undefined","forwardedValue","setForwardedValue","useCallback","v","nextValue","_default","exports"],"sources":["../../src/index.ts"],"sourcesContent":["import {\n Dispatch,\n SetStateAction,\n useCallback,\n useEffect,\n useMemo,\n useRef,\n useState,\n} from 'react';\n\ninterface UseForwardedStateProps<T> {\n value?: T;\n defaultValue?: T | (() => T);\n onChange?: (value: T) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types\nconst isFunction = (value: any): value is Function =>\n typeof value === 'function';\n\nconst useForwardedState = <T>({\n value,\n defaultValue,\n onChange,\n}: UseForwardedStateProps<T>): [\n T | undefined,\n Dispatch<SetStateAction<T | undefined>>,\n] => {\n const [innerValue, setInnerValue] = useState(defaultValue);\n const onChangeRef = useRef(onChange);\n\n useEffect(() => {\n onChangeRef.current = onChange;\n }, [onChange]);\n\n const shouldUseInnerValue = useMemo(() => value === undefined, [value]);\n const forwardedValue = useMemo(\n () => (shouldUseInnerValue ? innerValue : value),\n [shouldUseInnerValue, innerValue, value]\n );\n\n const setForwardedValue = useCallback<\n Dispatch<SetStateAction<T | undefined>>\n >(\n (v) => {\n const nextValue = isFunction(v) ? v(forwardedValue) : v;\n if (shouldUseInnerValue) setInnerValue(nextValue);\n if (onChangeRef.current && nextValue !== undefined)\n onChangeRef.current(nextValue);\n },\n [forwardedValue, shouldUseInnerValue]\n );\n\n return [forwardedValue, setForwardedValue];\n};\n\nexport default useForwardedState;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAQe,SAAAC,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;AAQf;AACA,IAAMsC,UAAU,GAAG,SAAbA,UAAUA,CAAIF,KAAU;EAAA,OAC5B,OAAOA,KAAK,KAAK,UAAU;AAAA;AAE7B,IAAMG,iBAAiB,GAAG,SAApBA,iBAAiBA,CAAAC,IAAA,EAOlB;EAAA,IANHJ,KAAK,GAAAI,IAAA,CAALJ,KAAK;IACLK,YAAY,GAAAD,IAAA,CAAZC,YAAY;IACZC,QAAQ,GAAAF,IAAA,CAARE,QAAQ;EAKR,IAAAC,SAAA,GAAoC,IAAAC,eAAQ,EAACH,YAAY,CAAC;IAAAI,UAAA,GAAA9C,cAAA,CAAA4C,SAAA;IAAnDG,UAAU,GAAAD,UAAA;IAAEE,aAAa,GAAAF,UAAA;EAChC,IAAMG,WAAW,GAAG,IAAAC,aAAM,EAACP,QAAQ,CAAC;EAEpC,IAAAQ,gBAAS,EAAC,YAAM;IACdF,WAAW,CAACG,OAAO,GAAGT,QAAQ;EAChC,CAAC,EAAE,CAACA,QAAQ,CAAC,CAAC;EAEd,IAAMU,mBAAmB,GAAG,IAAAC,cAAO,EAAC;IAAA,OAAMjB,KAAK,KAAKkB,SAAS;EAAA,GAAE,CAAClB,KAAK,CAAC,CAAC;EACvE,IAAMmB,cAAc,GAAG,IAAAF,cAAO,EAC5B;IAAA,OAAOD,mBAAmB,GAAGN,UAAU,GAAGV,KAAK;EAAA,CAAC,EAChD,CAACgB,mBAAmB,EAAEN,UAAU,EAAEV,KAAK,CACzC,CAAC;EAED,IAAMoB,iBAAiB,GAAG,IAAAC,kBAAW,EAGnC,UAACC,CAAC,EAAK;IACL,IAAMC,SAAS,GAAGrB,UAAU,CAACoB,CAAC,CAAC,GAAGA,CAAC,CAACH,cAAc,CAAC,GAAGG,CAAC;IACvD,IAAIN,mBAAmB,EAAEL,aAAa,CAACY,SAAS,CAAC;IACjD,IAAIX,WAAW,CAACG,OAAO,IAAIQ,SAAS,KAAKL,SAAS,EAChDN,WAAW,CAACG,OAAO,CAACQ,SAAS,CAAC;EAClC,CAAC,EACD,CAACJ,cAAc,EAAEH,mBAAmB,CACtC,CAAC;EAED,OAAO,CAACG,cAAc,EAAEC,iBAAiB,CAAC;AAC5C,CAAC;AAAC,IAAAI,QAAA,GAAAC,OAAA,cAEatB,iBAAiB","ignoreList":[]}
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["useCallback","useEffect","useMemo","useRef","useState","isFunction","value","useForwardedState","defaultValue","onChange","innerValue","setInnerValue","onChangeRef","current","shouldUseInnerValue","undefined","forwardedValue","setForwardedValue","v","nextValue"],"sources":["../../src/index.ts"],"sourcesContent":["import {\n Dispatch,\n SetStateAction,\n useCallback,\n useEffect,\n useMemo,\n useRef,\n useState,\n} from 'react';\n\ninterface UseForwardedStateProps<T> {\n value?: T;\n defaultValue?: T | (() => T);\n onChange?: (value: T) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types\nconst isFunction = (value: any): value is Function =>\n typeof value === 'function';\n\nconst useForwardedState = <T>({\n value,\n defaultValue,\n onChange,\n}: UseForwardedStateProps<T>): [\n T | undefined,\n Dispatch<SetStateAction<T | undefined>>,\n] => {\n const [innerValue, setInnerValue] = useState(defaultValue);\n const onChangeRef = useRef(onChange);\n\n useEffect(() => {\n onChangeRef.current = onChange;\n }, [onChange]);\n\n const shouldUseInnerValue = useMemo(() => value === undefined, [value]);\n const forwardedValue = useMemo(\n () => (shouldUseInnerValue ? innerValue : value),\n [shouldUseInnerValue, innerValue, value]\n );\n\n const setForwardedValue = useCallback<\n Dispatch<SetStateAction<T | undefined>>\n >(\n (v) => {\n const nextValue = isFunction(v) ? v(forwardedValue) : v;\n if (shouldUseInnerValue) setInnerValue(nextValue);\n if (onChangeRef.current && nextValue !== undefined)\n onChangeRef.current(nextValue);\n },\n [forwardedValue, shouldUseInnerValue]\n );\n\n return [forwardedValue, setForwardedValue];\n};\n\nexport default useForwardedState;\n"],"mappings":"AAAA,SAGEA,WAAW,EACXC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,OAAO;AAQd;AACA,MAAMC,UAAU,GAAIC,KAAU,IAC5B,OAAOA,KAAK,KAAK,UAAU;AAE7B,MAAMC,iBAAiB,GAAGA,CAAI;EAC5BD,KAAK;EACLE,YAAY;EACZC;AACyB,CAAC,KAGvB;EACH,MAAM,CAACC,UAAU,EAAEC,aAAa,CAAC,GAAGP,QAAQ,CAACI,YAAY,CAAC;EAC1D,MAAMI,WAAW,GAAGT,MAAM,CAACM,QAAQ,CAAC;EAEpCR,SAAS,CAAC,MAAM;IACdW,WAAW,CAACC,OAAO,GAAGJ,QAAQ;EAChC,CAAC,EAAE,CAACA,QAAQ,CAAC,CAAC;EAEd,MAAMK,mBAAmB,GAAGZ,OAAO,CAAC,MAAMI,KAAK,KAAKS,SAAS,EAAE,CAACT,KAAK,CAAC,CAAC;EACvE,MAAMU,cAAc,GAAGd,OAAO,CAC5B,MAAOY,mBAAmB,GAAGJ,UAAU,GAAGJ,KAAM,EAChD,CAACQ,mBAAmB,EAAEJ,UAAU,EAAEJ,KAAK,CACzC,CAAC;EAED,MAAMW,iBAAiB,GAAGjB,WAAW,CAGlCkB,CAAC,IAAK;IACL,MAAMC,SAAS,GAAGd,UAAU,CAACa,CAAC,CAAC,GAAGA,CAAC,CAACF,cAAc,CAAC,GAAGE,CAAC;IACvD,IAAIJ,mBAAmB,EAAEH,aAAa,CAACQ,SAAS,CAAC;IACjD,IAAIP,WAAW,CAACC,OAAO,IAAIM,SAAS,KAAKJ,SAAS,EAChDH,WAAW,CAACC,OAAO,CAACM,SAAS,CAAC;EAClC,CAAC,EACD,CAACH,cAAc,EAAEF,mBAAmB,CACtC,CAAC;EAED,OAAO,CAACE,cAAc,EAAEC,iBAAiB,CAAC;AAC5C,CAAC;AAED,eAAeV,iBAAiB"}
|
|
1
|
+
{"version":3,"file":"index.js","names":["useCallback","useEffect","useMemo","useRef","useState","isFunction","value","useForwardedState","defaultValue","onChange","innerValue","setInnerValue","onChangeRef","current","shouldUseInnerValue","undefined","forwardedValue","setForwardedValue","v","nextValue"],"sources":["../../src/index.ts"],"sourcesContent":["import {\n Dispatch,\n SetStateAction,\n useCallback,\n useEffect,\n useMemo,\n useRef,\n useState,\n} from 'react';\n\ninterface UseForwardedStateProps<T> {\n value?: T;\n defaultValue?: T | (() => T);\n onChange?: (value: T) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types\nconst isFunction = (value: any): value is Function =>\n typeof value === 'function';\n\nconst useForwardedState = <T>({\n value,\n defaultValue,\n onChange,\n}: UseForwardedStateProps<T>): [\n T | undefined,\n Dispatch<SetStateAction<T | undefined>>,\n] => {\n const [innerValue, setInnerValue] = useState(defaultValue);\n const onChangeRef = useRef(onChange);\n\n useEffect(() => {\n onChangeRef.current = onChange;\n }, [onChange]);\n\n const shouldUseInnerValue = useMemo(() => value === undefined, [value]);\n const forwardedValue = useMemo(\n () => (shouldUseInnerValue ? innerValue : value),\n [shouldUseInnerValue, innerValue, value]\n );\n\n const setForwardedValue = useCallback<\n Dispatch<SetStateAction<T | undefined>>\n >(\n (v) => {\n const nextValue = isFunction(v) ? v(forwardedValue) : v;\n if (shouldUseInnerValue) setInnerValue(nextValue);\n if (onChangeRef.current && nextValue !== undefined)\n onChangeRef.current(nextValue);\n },\n [forwardedValue, shouldUseInnerValue]\n );\n\n return [forwardedValue, setForwardedValue];\n};\n\nexport default useForwardedState;\n"],"mappings":"AAAA,SAGEA,WAAW,EACXC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,OAAO;AAQd;AACA,MAAMC,UAAU,GAAIC,KAAU,IAC5B,OAAOA,KAAK,KAAK,UAAU;AAE7B,MAAMC,iBAAiB,GAAGA,CAAI;EAC5BD,KAAK;EACLE,YAAY;EACZC;AACyB,CAAC,KAGvB;EACH,MAAM,CAACC,UAAU,EAAEC,aAAa,CAAC,GAAGP,QAAQ,CAACI,YAAY,CAAC;EAC1D,MAAMI,WAAW,GAAGT,MAAM,CAACM,QAAQ,CAAC;EAEpCR,SAAS,CAAC,MAAM;IACdW,WAAW,CAACC,OAAO,GAAGJ,QAAQ;EAChC,CAAC,EAAE,CAACA,QAAQ,CAAC,CAAC;EAEd,MAAMK,mBAAmB,GAAGZ,OAAO,CAAC,MAAMI,KAAK,KAAKS,SAAS,EAAE,CAACT,KAAK,CAAC,CAAC;EACvE,MAAMU,cAAc,GAAGd,OAAO,CAC5B,MAAOY,mBAAmB,GAAGJ,UAAU,GAAGJ,KAAM,EAChD,CAACQ,mBAAmB,EAAEJ,UAAU,EAAEJ,KAAK,CACzC,CAAC;EAED,MAAMW,iBAAiB,GAAGjB,WAAW,CAGlCkB,CAAC,IAAK;IACL,MAAMC,SAAS,GAAGd,UAAU,CAACa,CAAC,CAAC,GAAGA,CAAC,CAACF,cAAc,CAAC,GAAGE,CAAC;IACvD,IAAIJ,mBAAmB,EAAEH,aAAa,CAACQ,SAAS,CAAC;IACjD,IAAIP,WAAW,CAACC,OAAO,IAAIM,SAAS,KAAKJ,SAAS,EAChDH,WAAW,CAACC,OAAO,CAACM,SAAS,CAAC;EAClC,CAAC,EACD,CAACH,cAAc,EAAEF,mBAAmB,CACtC,CAAC;EAED,OAAO,CAACE,cAAc,EAAEC,iBAAiB,CAAC;AAC5C,CAAC;AAED,eAAeV,iBAAiB","ignoreList":[]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -4,6 +4,9 @@ interface UseForwardedStateProps<T> {
|
|
|
4
4
|
defaultValue?: T | (() => T);
|
|
5
5
|
onChange?: (value: T) => void;
|
|
6
6
|
}
|
|
7
|
-
declare const useForwardedState: <T>({ value, defaultValue, onChange, }: UseForwardedStateProps<T>) => [
|
|
7
|
+
declare const useForwardedState: <T>({ value, defaultValue, onChange, }: UseForwardedStateProps<T>) => [
|
|
8
|
+
T | undefined,
|
|
9
|
+
Dispatch<SetStateAction<T | undefined>>
|
|
10
|
+
];
|
|
8
11
|
export default useForwardedState;
|
|
9
12
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,cAAc,EAMf,MAAM,OAAO,CAAC;AAEf,UAAU,sBAAsB,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC/B;AAMD,QAAA,MAAM,iBAAiB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,cAAc,EAMf,MAAM,OAAO,CAAC;AAEf,UAAU,sBAAsB,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC/B;AAMD,QAAA,MAAM,iBAAiB,0CAIpB,uBAAuB,CAAC,CAAC,KAAG;IAC7B,CAAC,GAAG,SAAS;IACb,SAAS,eAAe,CAAC,GAAG,SAAS,CAAC,CAAC;CA4BxC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@os-design/use-forwarded-state",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.22",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"repository": "git@gitlab.com:os-team/libs/os-design.git",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"react": ">=18"
|
|
35
35
|
},
|
|
36
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "1f17189e344a56fd6347dd6b896d6e7ef6e7b35d"
|
|
37
37
|
}
|
package/src/index.mdx
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
import UseForwardedStateExample from './index.example';
|
|
3
|
+
|
|
4
|
+
<Meta title='Utils/useForwardedState' />
|
|
5
|
+
|
|
6
|
+
# useForwardedState
|
|
7
|
+
|
|
8
|
+
Uses the inner state if the passed value is undefined.
|
|
9
|
+
|
|
10
|
+
## Example of usage
|
|
11
|
+
|
|
12
|
+
```tsx
|
|
13
|
+
import React, { forwardRef } from 'react';
|
|
14
|
+
import { Button } from '@os-design/core';
|
|
15
|
+
import { useForwardedState } from '@os-design/utils';
|
|
16
|
+
|
|
17
|
+
type JsxInputProps = Omit<
|
|
18
|
+
JSX.IntrinsicElements['input'],
|
|
19
|
+
'value' | 'defaultValue' | 'onChange' | 'ref'
|
|
20
|
+
>;
|
|
21
|
+
interface InputProps extends JsxInputProps {
|
|
22
|
+
value?: string;
|
|
23
|
+
defaultValue?: string | (() => string);
|
|
24
|
+
onChange?: (value: string) => void;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const UseForwardedStateExample = forwardRef<HTMLInputElement, InputProps>(
|
|
28
|
+
({ value, defaultValue, onChange, ...rest }, ref) => {
|
|
29
|
+
const [forwardedValue, setForwardedValue] = useForwardedState({
|
|
30
|
+
value,
|
|
31
|
+
defaultValue,
|
|
32
|
+
onChange,
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
return (
|
|
36
|
+
<>
|
|
37
|
+
<p>
|
|
38
|
+
<input
|
|
39
|
+
value={forwardedValue}
|
|
40
|
+
onChange={(e) => setForwardedValue(e.target.value)}
|
|
41
|
+
{...rest}
|
|
42
|
+
ref={ref}
|
|
43
|
+
/>
|
|
44
|
+
</p>
|
|
45
|
+
<Button onClick={() => setForwardedValue('')}>Clear</Button>
|
|
46
|
+
</>
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
);
|
|
50
|
+
|
|
51
|
+
export default UseForwardedStateExample;
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
<UseForwardedStateExample />
|