taro-form-react 0.3.1 → 0.4.1

package/dist/types/src/components/Provider.d.ts

@@ -2,7 +2,7 @@ import React from "react";
 import { useFormContext } from "../context/FormContext";
 import { useInnerFormContext } from "../context/InnerFormContext";
 export type FormProviderProps = {
-    children: (context: Omit<ReturnType<typeof useFormContext>, "registerField" | "unregisterField" | "setFieldValue" | "setFields" | "resetFields" | "setFieldError" | "setData"> & ReturnType<typeof useInnerFormContext>) => React.ReactNode;
+    children: (context: Omit<ReturnType<typeof useFormContext>, "registerField" | "unregisterField" | "setFieldValue" | "setFields" | "resetFields" | "setFieldError" | "setData" | "capture" | "restore"> & ReturnType<typeof useInnerFormContext>) => React.ReactNode;
 };
 declare const FormProvider: React.FC<FormProviderProps>;
 export default FormProvider;

package/dist/types/src/context/FormContext.d.ts

@@ -18,6 +18,14 @@ export type Field = {
     initialValue?: any;
     count: number;
 };
+export type FormSnapshotField = {
+    touched: boolean;
+    errors: string[];
+};
+export type FormSnapshot = {
+    data: Record<string, unknown>;
+    fields: Record<string, FormSnapshotField>;
+};
 export type FormContextProps = {
     initialValues?: Record<string, any>;
     showError?: boolean;
@@ -54,6 +62,8 @@ export type FormContextProps = {
     isFieldsTouched: (nameList?: NamePath[], options?: {
         allTouched?: boolean;
     }) => boolean;
+    capture: () => FormSnapshot;
+    restore: (snapshot: FormSnapshot) => void;
 };
 export declare const useFormContext: () => FormContextProps;
 export type FormProviderConfiguration = Pick<FormContextProps, "colon" | "labelProps" | "layout" | "validateFirst" | "showErrors" | "passthroughErrors" | "transformBehavior" | "updateTickLimit" | "getRequiredMessage">;

package/dist/types/src/index.d.ts

@@ -4,11 +4,13 @@ import FormKeep from "./components/Keep";
 import FormLabel from "./components/Label";
 import FormProvider from "./components/Provider";
 import FormSync from "./components/Sync";
-import type { Field, FormContextProps, FormProviderConfiguration } from "./context/FormContext";
+import type { Field, FormContextProps, FormProviderConfiguration, FormSnapshot } from "./context/FormContext";
 import { useFormContext } from "./context/FormContext";
+export type FormSnapshotActions = Pick<FormContextProps, "capture" | "restore">;
 export type FormActions = Pick<FormContextProps, "setData" | "setFieldValue" | "getFieldValue" | "getFieldsValue" | "getFieldsFormattedValue" | "setFields" | "getFields" | "resetFields" | "setFieldError" | "getFieldError" | "validateFields" | "isFieldsTouched"> & {
     submit: () => Promise<Record<string, any> | undefined>;
     reset: () => void;
+    snapshot: FormSnapshotActions;
 };
 export type FormProps = FormProviderConfiguration & {
     initialValues?: Record<string, any>;
@@ -35,3 +37,4 @@ interface FormComponent extends React.ForwardRefExoticComponent<FormProps & Reac
 declare const Form: FormComponent;
 export default Form;
 export { useFormContext };
+export type { FormSnapshot };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "taro-form-react",
   "description": "A form component for Taro 3.x based on React",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "browser": "dist/index.umd.js",
   "module": "dist/index.esm.js",
   "main": "dist/index.js",