@fairys/valtio-form-basic 0.0.11 → 0.0.12

package/esm/form/form.d.ts

@@ -14,8 +14,13 @@ export interface FairysValtioFormAttrsProps<T extends MObject<T> = object> exten
     formData?: FairysValtioFormInstance<T>['state'];
     /**表单隐藏状态*/
     hideState?: FairysValtioFormInstance<T>['hideState'];
-    /**formData 是否进行深度拷贝，如果不是则直接把 formData 赋值到 state ，否则使用 copy 方法深度拷贝后赋值 */
-    isDeepCopy?: boolean;
+    /**
+     * 初始化表单数据类型，默认值为 deepCopy
+     * - deepCopy：使用深度拷贝初始化表单数据
+     * - proxy：使用代理对象初始化表单数据
+     * - immutable：直接使用对象，不进行任何处理，注意，这个使用必须是`valtio`中的`proxy`声明的对象数据，否则表单项更新数据不会同步
+     */
+    initFormDataType?: 'deepCopy' | 'proxy' | 'immutable';
 }
 /**
  * 表单属性处理

package/esm/form/form.js

@@ -1,13 +1,13 @@
 import { useFairysValtioFormInstance } from "./instance/index.js";
 import { useMemo } from "react";
 function useFairysValtioForm(props) {
-    const { form, rules, formData, hideState, isDeepCopy = true, ...rest } = props;
+    const { form, rules, formData, hideState, initFormDataType = 'deepCopy', ...rest } = props;
     const formInstance = useFairysValtioFormInstance(form);
     formInstance.rules = rules;
     useMemo(()=>formInstance.ctor({
             formData,
             hideState,
-            isDeepCopy
+            initFormDataType
         }), []);
     return {
         ...rest,

package/esm/form/instance/index.d.ts

@@ -14,7 +14,7 @@ export declare class FairysValtioFormInstance<T extends MObject<T> = Record<stri
     ctor: (options?: {
         formData?: Partial<T>;
         hideState?: Record<PropertyKey, boolean>;
-        isDeepCopy?: boolean;
+        initFormDataType?: "deepCopy" | "proxy" | "immutable";
     }) => void;
     /**
      * 更新数据

package/esm/form/instance/index.js

@@ -8,11 +8,12 @@ class FairysValtioFormInstance {
     errorState = proxy({});
     hideState = proxy({});
     ctor = (options)=>{
-        const { formData, hideState, isDeepCopy = true } = options || {};
+        const { formData, hideState, initFormDataType = 'deepCopy' } = options || {};
         this.errorState = proxy({});
         this.hideState = proxy(hideState ? copy(hideState) : {});
-        if (isDeepCopy) this.state = proxy(formData ? copy(formData) : {});
-        else if (formData) this.state = proxy(formData);
+        if ('deepCopy' === initFormDataType) this.state = proxy(formData ? copy(formData) : {});
+        else if ('proxy' === initFormDataType) this.state = proxy(formData);
+        else if ('immutable' === initFormDataType) this.state = formData;
     };
     updated = (state, isValidate = true)=>{
         const keys = Object.keys(state);

package/package.json

@@ -3,7 +3,7 @@
   "author": "SunLxy <1011771396@qq.com>",
   "description": "使用 valtio 实现的表单基础库, 使其更加便捷，同时支持`PC`、`H5`、`Taro`，同时也更加灵活。",
   "homepage": "https://github.com/autumn-fairy-tales/fairys-taro-react",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "main": "lib/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",

package/src/form/form.tsx

@@ -15,8 +15,13 @@ export interface FairysValtioFormAttrsProps<T extends MObject<T> = object> exten
   formData?: FairysValtioFormInstance<T>['state'];
   /**表单隐藏状态*/
   hideState?: FairysValtioFormInstance<T>['hideState'];
-  /**formData 是否进行深度拷贝，如果不是则直接把 formData 赋值到 state ，否则使用 copy 方法深度拷贝后赋值 */
-  isDeepCopy?: boolean;
+  /**
+   * 初始化表单数据类型，默认值为 deepCopy
+   * - deepCopy：使用深度拷贝初始化表单数据
+   * - proxy：使用代理对象初始化表单数据
+   * - immutable：直接使用对象，不进行任何处理，注意，这个使用必须是`valtio`中的`proxy`声明的对象数据，否则表单项更新数据不会同步
+   */
+  initFormDataType?: 'deepCopy' | 'proxy' | 'immutable';
 }
 
 /**
@@ -40,12 +45,12 @@ export const Form = (props: FormProps) => {
  * ```
 */
 export function useFairysValtioForm<T extends MObject<T> = object>(props: FairysValtioFormAttrsProps<T>) {
-  const { form, rules, formData, hideState, isDeepCopy = true, ...rest } = props;
+  const { form, rules, formData, hideState, initFormDataType = 'deepCopy', ...rest } = props;
   const formInstance = useFairysValtioFormInstance(form);
   /**表单规则*/
   formInstance.rules = rules;
   /**初始化表单值*/
-  useMemo(() => formInstance.ctor({ formData, hideState, isDeepCopy }), []);
+  useMemo(() => formInstance.ctor({ formData, hideState, initFormDataType }), []);
   return {
     ...rest,
     formInstance,

package/src/form/instance/index.ts

@@ -16,15 +16,21 @@ export class FairysValtioFormInstance<T extends MObject<T> = Record<string, any>
   /**隐藏状态*/
   hideState = proxy<Record<PropertyKey, boolean>>({});
   /**初始化表单值*/
-  ctor = (options?: { formData?: Partial<T>; hideState?: Record<PropertyKey, boolean>; isDeepCopy?: boolean }) => {
-    const { formData, hideState, isDeepCopy = true } = options || {};
+  ctor = (options?: {
+    formData?: Partial<T>;
+    hideState?: Record<PropertyKey, boolean>;
+    initFormDataType?: 'deepCopy' | 'proxy' | 'immutable';
+  }) => {
+    const { formData, hideState, initFormDataType = 'deepCopy' } = options || {};
     // 如果是 isProxy,则直接赋值
     this.errorState = proxy<Record<PropertyKey, string[]>>({});
     this.hideState = proxy<Record<PropertyKey, boolean>>(hideState ? copy(hideState) : {});
-    if (isDeepCopy) {
+    if (initFormDataType === 'deepCopy') {
       this.state = proxy((formData ? copy(formData) : {}) as T);
-    } else if (formData) {
+    } else if (initFormDataType === 'proxy') {
       this.state = proxy(formData as T);
+    } else if (initFormDataType === 'immutable') {
+      this.state = formData as T;
     }
   };
   /**