@os-design/use-forwarded-state 1.0.13 → 1.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@os-design/use-forwarded-state",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "license": "UNLICENSED",
   "repository": "git@gitlab.com:os-team/libs/os-design.git",
   "main": "dist/cjs/index.js",
@@ -14,7 +14,15 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "!**/*.test.ts",
+    "!**/*.test.tsx",
+    "!**/__tests__",
+    "!**/*.stories.tsx",
+    "!**/*.stories.mdx",
+    "!**/*.example.tsx",
+    "!**/*.emotion.d.ts"
   ],
   "sideEffects": false,
   "scripts": {
@@ -31,5 +39,5 @@
   "peerDependencies": {
     "react": ">=18"
   },
-  "gitHead": "0e88d3afc41e36cee61222a039ef1aa4d08115b5"
+  "gitHead": "3d6b264027712ef81a75379fe3fde3c76c3079af"
 }

package/src/index.ts

@@ -0,0 +1,57 @@
+import {
+  Dispatch,
+  SetStateAction,
+  useCallback,
+  useEffect,
+  useMemo,
+  useRef,
+  useState,
+} from 'react';
+
+interface UseForwardedStateProps<T> {
+  value?: T;
+  defaultValue?: T | (() => T);
+  onChange?: (value: T) => void;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
+const isFunction = (value: any): value is Function =>
+  typeof value === 'function';
+
+const useForwardedState = <T>({
+  value,
+  defaultValue,
+  onChange,
+}: UseForwardedStateProps<T>): [
+  T | undefined,
+  Dispatch<SetStateAction<T | undefined>>
+] => {
+  const [innerValue, setInnerValue] = useState(defaultValue);
+  const onChangeRef = useRef(onChange);
+
+  useEffect(() => {
+    onChangeRef.current = onChange;
+  }, [onChange]);
+
+  const shouldUseInnerValue = useMemo(() => value === undefined, [value]);
+  const forwardedValue = useMemo(
+    () => (shouldUseInnerValue ? innerValue : value),
+    [shouldUseInnerValue, innerValue, value]
+  );
+
+  const setForwardedValue = useCallback<
+    Dispatch<SetStateAction<T | undefined>>
+  >(
+    (v) => {
+      const nextValue = isFunction(v) ? v(forwardedValue) : v;
+      if (shouldUseInnerValue) setInnerValue(nextValue);
+      if (onChangeRef.current && nextValue !== undefined)
+        onChangeRef.current(nextValue);
+    },
+    [forwardedValue, shouldUseInnerValue]
+  );
+
+  return [forwardedValue, setForwardedValue];
+};
+
+export default useForwardedState;