react-store-input 0.1.1 → 0.1.4

package/README.md

@@ -14,29 +14,29 @@ This is a simple example of how to use this package.
 import { useFormStore } from "dn-react-input";
 
 export default function App() {
-    const store = useFormStore({
-        email: "",
-        password: "",
-    });
-
-    const submit = async () => {
-        const { email, password } = store.state;
-
-        alert(`Email: ${email}\nPassword: ${password}`);
-    };
-
-    return (
-        <form
-            onSubmit={(e) => {
-                e.preventDefault();
-                submit();
-            }}
-        >
-            <store.input name="email" type="email" />
-            <store.input name="password" type="password" />
-            <button type="submit">Submit</button>
-        </form>
-    );
+  const store = useFormStore({
+    email: "",
+    password: "",
+  });
+
+  const submit = async () => {
+    const { email, password } = store.state;
+
+    alert(`Email: ${email}\nPassword: ${password}`);
+  };
+
+  return (
+    <form
+      onSubmit={(e) => {
+        e.preventDefault();
+        submit();
+      }}
+    >
+      <store.input name="email" type="email" />
+      <store.input name="password" type="password" />
+      <button type="submit">Submit</button>
+    </form>
+  );
 }
 ```
 
@@ -96,20 +96,20 @@ function Component() {
 }
 ```
 
-If you want to avoid passing the store to each input component, use `useStoreInput`. This hook provides input components that are already connected to the store.
+If you want to avoid passing the store to each input component, use `useStoreComponent`. This hook provides input components that are already connected to the store.
 
 ```tsx
-import { useStoreInput } from "dn-react-input";
+import { useStoreComponent } from "dn-react-input";
 
 function Component() {
     ...
-    const Input = useStoreInput(store);
+    const component = useStoreComponent(store);
 
     return (
         <form>
-            <Input.input name="email" type="email" />
-            <Input.input name="password" type="password" />
-            <Input.input name="rememberMe" type="checkbox" />
+            <component.input name="email" type="email" />
+            <component.input name="password" type="password" />
+            <component.input name="rememberMe" type="checkbox" />
         </form>
     );
 }
@@ -169,6 +169,28 @@ function Component() {
 }
 ```
 
+`Store.render` is a shortcut for `createRender` when you use `useFormStore`.
+
+```tsx
+function Component() {
+  const store = useFormStore({
+    email: "",
+    password: "",
+  });
+
+  return (
+    <div>
+      {store.render((state) => (
+        <p>{state.email}</p>
+      ))}
+      {store.render((state) => (
+        <p>{state.password}</p>
+      ))}
+    </div>
+  );
+}
+```
+
 ## How to subscribe to state changes?
 
 You can subscribe to state changes using the `subscribe` method of the store.
@@ -220,3 +242,44 @@ function Component() {
     return <button onClick={updateEmail}>Update Email</button>;
 }
 ```
+
+## How to create custom input components?
+
+You can create custom input components using the `useStoreInput` hook. This hook provides the necessary props to connect your custom input component to the store: `name`, `value`, `defaultValue`, `defaultChecked`, `onChange`, and `ref` which already subscribed to the store.
+
+```tsx
+import { useStoreInput } from "dn-react-input";
+
+function CustomInput({ store }: { store: Store<{ email: string }> }) {
+  const inputProps = useStoreInput(store, {
+    name: "email",
+  });
+
+  return <input {...inputProps} />;
+}
+```
+
+## How to creatre custom controller components?
+
+If your custom component is not an html input element, you can use the `useStoreController` hook. This hook provides the necessary props to connect your custom controller component to the store: `ref`, `onSubscribe`, and `onDispatch`.
+
+```tsx
+import { useStoreController } from "dn-react-input";
+
+type State = {
+  count: number;
+};
+
+function CustomController({ store }: { store: Store<State> }) {
+  const controllerProps = useStoreController<HTMLDivElement, State>(store, {
+    onSubscribe: (state, element) => {
+      element.textContent = `Count: ${state.count}`;
+    },
+    onDispatch: (state, element) => {
+      state.count += Number(element.textContent.replace("Count: ", ""));
+    },
+  });
+
+  return <div {...controllerProps} />;
+}
+```

package/dist/index.d.mts

@@ -1,8 +1,10 @@
 export { Store, StoreSubscriber, useStore } from './use_store.mjs';
 export { useSelector } from './use_selector.mjs';
 export { useSubscribe } from './use_subscribe.mjs';
-export { Input, Select, StoreInputPropsWithStore, Textarea, useStoreInput } from './use_store_input.mjs';
-export { useStoreInputProps } from './use_store_input_props.mjs';
+export { StoreControllerProps, useStoreController } from './use_store_controller.mjs';
+export { useStoreInputWithName } from './use_store_input_with_name.mjs';
+export { StoreInputProps, useStoreInput } from './use_store_input.mjs';
+export { Input, Select, StoreComponentProps, StoreComponentPropsWithStore, Textarea, useStoreComponent } from './use_store_component.mjs';
 export { FormStore, useFormStore } from './use_form_store.mjs';
 export { deserialize, serialize } from './serialize.mjs';
 import 'react';

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 export { Store, StoreSubscriber, useStore } from './use_store.js';
 export { useSelector } from './use_selector.js';
 export { useSubscribe } from './use_subscribe.js';
-export { Input, Select, StoreInputPropsWithStore, Textarea, useStoreInput } from './use_store_input.js';
-export { useStoreInputProps } from './use_store_input_props.js';
+export { StoreControllerProps, useStoreController } from './use_store_controller.js';
+export { useStoreInputWithName } from './use_store_input_with_name.js';
+export { StoreInputProps, useStoreInput } from './use_store_input.js';
+export { Input, Select, StoreComponentProps, StoreComponentPropsWithStore, Textarea, useStoreComponent } from './use_store_component.js';
 export { FormStore, useFormStore } from './use_form_store.js';
 export { deserialize, serialize } from './serialize.js';
 import 'react';

package/dist/index.js

@@ -38,8 +38,10 @@ __export(index_exports, {
   useFormStore: () => useFormStore,
   useSelector: () => useSelector,
   useStore: () => useStore,
+  useStoreComponent: () => useStoreComponent,
+  useStoreController: () => useStoreController,
   useStoreInput: () => useStoreInput,
-  useStoreInputProps: () => useStoreInputProps,
+  useStoreInputWithName: () => useStoreInputWithName,
   useSubscribe: () => useSubscribe
 });
 module.exports = __toCommonJS(index_exports);
@@ -115,14 +117,51 @@ function useSelector(store, selector, compare = (a, b) => a === b) {
   return state;
 }
 
+// src/use_store_controller.tsx
+var import_react4 = require("react");
+function useStoreController(store, props) {
+  const ref = (0, import_react4.useRef)(null);
+  const dispatchKey = (0, import_react4.useId)();
+  (0, import_react4.useEffect)(() => {
+    const element = ref.current;
+    if (!element) {
+      return;
+    }
+    if (typeof props.ref === "function") {
+      props.ref(element);
+    } else if (props.ref) {
+      props.ref.current = element;
+    }
+  }, []);
+  useSubscribe(store, (state, key) => {
+    if (key === dispatchKey) {
+      return;
+    }
+    if (!ref.current) return;
+    props.onSubscribe(state, ref.current);
+  });
+  const onChange = () => {
+    store.dispatch(
+      (state) => {
+        const element = ref.current;
+        if (!element) return;
+        props.onDispatch(state, element);
+      },
+      {
+        key: dispatchKey
+      }
+    );
+  };
+  return {
+    ref,
+    onChange
+  };
+}
+
 // src/use_store_input.tsx
 var import_react5 = require("react");
-var import_react6 = __toESM(require("react"));
-
-// src/use_store_input_props.tsx
-var import_react4 = require("react");
 var import_date_fns = require("date-fns");
-function useStoreInputProps(store, props) {
+function useStoreInput(store, props) {
   const toInputValue = (value) => {
     if (value === void 0 || value === null) {
       return "";
@@ -144,7 +183,7 @@ function useStoreInputProps(store, props) {
     if (props.type === "checkbox" || props.type === "radio") {
       return void 0;
     }
-    return toInputValue(store.state[props.name]);
+    return toInputValue(props.getter(store.state));
   };
   const toInputChecked = (value) => {
     if (props.type === "radio") {
@@ -159,103 +198,92 @@ function useStoreInputProps(store, props) {
     if (props.type !== "checkbox" && props.type !== "radio") {
       return void 0;
     }
-    return toInputChecked(store.state[props.name]);
+    return toInputChecked(props.getter(store.state));
   };
-  function useSubscriptionRef() {
-    const ref2 = (0, import_react4.useRef)(null);
-    (0, import_react4.useEffect)(() => {
-      const input = ref2.current;
-      if (!input) {
-        return;
-      }
-      if (typeof props.ref === "function") {
-        props.ref(input);
-      } else if (props.ref) {
-        props.ref.current = input;
-      }
-      return store.subscribe((state, key) => {
-        if (key === dispatchKey) {
-          return;
-        }
-        if (props.type === "checkbox" || props.type === "radio") {
-          const checked = toInputChecked(state[props.name]);
-          if (input.checked === checked) {
-            return;
-          }
-          input.checked = checked;
-        } else {
-          const value = toInputValue(state[props.name]);
-          if (input.value === value) {
-            return;
-          }
-          input.value = value;
-        }
-        const event = new Event("input", { bubbles: true });
-        input.dispatchEvent(event);
-      });
-    }, []);
-    return ref2;
-  }
   function toStateValue(value) {
-    if (typeof store.state[props.name] === "number") {
+    const selected = props.getter(store.state);
+    if (typeof selected === "number") {
       return Number(value);
     }
-    if (store.state[props.name] instanceof Date) {
+    if (selected instanceof Date) {
       return new Date(value);
     }
     return value;
   }
-  function createChangeEventHandler() {
-    return (e) => {
-      const target = e.target;
-      if (props.type === "checkbox") {
-        store.dispatch(
-          (state) => {
-            state[props.name] = target.checked;
-          },
-          {
-            key: dispatchKey
-          }
-        );
+  const inputProps = useStoreController(store, {
+    ref: props.ref,
+    onSubscribe: (state, element) => {
+      if ("checked" in element && (props.type === "checkbox" || props.type === "radio")) {
+        const checked = toInputChecked(props.getter(state));
+        if (element.checked === checked) {
+          return;
+        }
+        element.checked = checked;
       } else {
-        store.dispatch(
-          (state) => {
-            state[props.name] = toStateValue(target.value);
-          },
-          {
-            key: dispatchKey
-          }
-        );
+        const value = toInputValue(props.getter(state));
+        if (element.value === value) {
+          return;
+        }
+        element.value = value;
       }
-      props.onChange?.(e);
-    };
-  }
-  const dispatchKey = (0, import_react4.useId)();
-  const ref = useSubscriptionRef();
-  const name = String(props.name);
-  const defaultValue = getDefaultValue();
-  const defaultChecked = getDefaultChecked();
-  const onChange = createChangeEventHandler();
+      const event = new Event("input", { bubbles: true });
+      element.dispatchEvent(event);
+    },
+    onDispatch: (state, element) => {
+      if ("checked" in element && props.type === "checkbox") {
+        props.setter(state, element.checked);
+      } else {
+        props.setter(state, toStateValue(element.value));
+      }
+    }
+  });
   return {
-    key: dispatchKey,
-    ref,
-    name,
-    defaultValue,
-    defaultChecked,
-    onChange
+    ref: inputProps.ref,
+    defaultValue: getDefaultValue(),
+    defaultChecked: getDefaultChecked(),
+    onChange: (event) => {
+      inputProps.onChange();
+      props.onChange?.(event);
+    }
   };
 }
 
-// src/use_store_input.tsx
-function useStoreInput(store) {
-  const input = (0, import_react5.useCallback)(function Component(props) {
-    return /* @__PURE__ */ import_react6.default.createElement(Input, { store, ...props });
+// src/use_store_input_with_name.tsx
+function useStoreInputWithName(store, props) {
+  const inputProps = useStoreInput(store, {
+    ...props,
+    getter: (state) => {
+      if (props.getter) {
+        return props.getter(state);
+      }
+      return state[props.name];
+    },
+    setter: (state, value) => {
+      if (props.setter) {
+        props.setter(state, value);
+        return;
+      }
+      state[props.name] = value;
+    }
+  });
+  return {
+    ...inputProps,
+    name: "name" in props ? String(props.name) : void 0
+  };
+}
+
+// src/use_store_component.tsx
+var import_react6 = require("react");
+var import_react7 = __toESM(require("react"));
+function useStoreComponent(store) {
+  const input = (0, import_react6.useCallback)(function Component(props) {
+    return /* @__PURE__ */ import_react7.default.createElement(Input, { store, ...props });
   }, []);
-  const select = (0, import_react5.useCallback)(function Component(props) {
-    return /* @__PURE__ */ import_react6.default.createElement(Select, { store, ...props });
+  const select = (0, import_react6.useCallback)(function Component(props) {
+    return /* @__PURE__ */ import_react7.default.createElement(Select, { store, ...props });
   }, []);
-  const textarea = (0, import_react5.useCallback)(function Component(props) {
-    return /* @__PURE__ */ import_react6.default.createElement(Textarea, { store, ...props });
+  const textarea = (0, import_react6.useCallback)(function Component(props) {
+    return /* @__PURE__ */ import_react7.default.createElement(Textarea, { store, ...props });
   }, []);
   return {
     input,
@@ -265,43 +293,49 @@ function useStoreInput(store) {
 }
 function Input({
   store,
+  getter,
+  setter,
   ...props
 }) {
-  const storeProps = useStoreInputProps(store, props);
-  return /* @__PURE__ */ import_react6.default.createElement("input", { ...props, ...storeProps });
+  const storeProps = useStoreInputWithName(store, { ...props, getter, setter });
+  return /* @__PURE__ */ import_react7.default.createElement("input", { ...props, ...storeProps });
 }
 function Select({
   store,
+  getter,
+  setter,
   ...props
 }) {
-  const storeProps = useStoreInputProps(store, props);
-  return /* @__PURE__ */ import_react6.default.createElement("select", { ...props, ...storeProps });
+  const storeProps = useStoreInputWithName(store, { ...props, getter, setter });
+  return /* @__PURE__ */ import_react7.default.createElement("select", { ...props, ...storeProps });
 }
 function Textarea({
   store,
+  getter,
+  setter,
   ...props
 }) {
-  const storeProps = useStoreInputProps(store, props);
-  return /* @__PURE__ */ import_react6.default.createElement("textarea", { ...props, ...storeProps });
+  const storeProps = useStoreInputWithName(store, { ...props, getter, setter });
+  return /* @__PURE__ */ import_react7.default.createElement("textarea", { ...props, ...storeProps });
 }
 
 // src/create_render.tsx
-var import_react7 = __toESM(require("react"));
+var import_react8 = __toESM(require("react"));
 function createRenderWithStore(store) {
   return function createRender(selector, compare) {
     function Component() {
       const result = useSelector(store, (state) => state, compare);
       const content = selector(result);
-      return /* @__PURE__ */ import_react7.default.createElement(import_react7.default.Fragment, null, content);
+      return /* @__PURE__ */ import_react8.default.createElement(import_react8.default.Fragment, null, content);
     }
-    return /* @__PURE__ */ import_react7.default.createElement(Component, null);
+    return /* @__PURE__ */ import_react8.default.createElement(Component, null);
   };
 }
 
 // src/use_form_store.tsx
 function useFormStore(initialState) {
   const store = useStore(initialState);
-  const storeInput = useStoreInput(store);
+  const storeComponent = useStoreComponent(store);
   return {
     get state() {
       return store.state;
@@ -309,7 +343,7 @@ function useFormStore(initialState) {
     dispatch: store.dispatch,
     subscribe: store.subscribe,
     render: createRenderWithStore(store),
-    ...storeInput
+    ...storeComponent
   };
 }
 
@@ -409,7 +443,9 @@ function deserialize(data) {
   useFormStore,
   useSelector,
   useStore,
+  useStoreComponent,
+  useStoreController,
   useStoreInput,
-  useStoreInputProps,
+  useStoreInputWithName,
   useSubscribe
 });