@unicom-cloud/ui 0.8.83 → 0.8.84

package/types/pc/form/interface.d.ts

@@ -0,0 +1,544 @@
+import { Options as ScrollIntoViewOptions } from '@unicom-cloud/scroll-into-view-if-needed';
+import type { ValidateMessagesTemplateType } from '@unicom-cloud/validate/types';
+import React, { CSSProperties, FormHTMLAttributes, HTMLAttributes, ReactElement, ReactNode } from 'react';
+import { JSX } from 'react/jsx-runtime';
+import { ColProps } from '../grid/Col';
+import type { TooltipProps } from '../tooltip/interface';
+import Store from './store';
+export type IndexedObject = {
+    [key: string]: any;
+};
+export type KeyType = string | number | symbol;
+export type ComponentType = keyof JSX.IntrinsicElements | React.ComponentType<any>;
+export type FieldError<FieldValue = any> = {
+    value?: FieldValue;
+    message?: ReactNode;
+    type?: string;
+    requiredError?: boolean;
+};
+export type ValidateFieldsErrors<FieldValue = any, FieldKey extends KeyType = string> = Record<FieldKey, FieldValue> | undefined | null;
+/**
+ * @title Form
+ */
+export interface FormProps<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> extends Omit<FormHTMLAttributes<any>, 'className' | 'onChange' | 'onSubmit' | 'onReset'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    prefixCls?: string;
+    /**
+     * @zh form
+     * @en form
+     */
+    form?: FormInstance<FormData, FieldValue, FieldKey>;
+    /**
+     * @zh 设置后，会作为表单控件 `id`的前缀。
+     * @en prefix of `id` attr
+     */
+    id?: string;
+    /**
+     * @zh 表单的布局，有三种布局，水平、垂直、多列。
+     * @en The layout of Form
+     * @defaultValue horizontal
+     */
+    layout?: 'horizontal' | 'vertical' | 'inline';
+    /**
+     * @zh 不同尺寸。
+     * @en size of form
+     */
+    size?: 'mini' | 'small' | 'default' | 'large';
+    /**
+     * @zh
+     * `<label>`标签布局，同[<Grid.Col>](/react/component/grid)组件接收的参数相同，
+     * 可以配置`span`和`offset`值，会覆盖全局的`labelCol`设置
+     * @en
+     * Global `<label>` label layout. Same as the props received by the `<Grid.Col>`,
+     * the values of `span` and `offset` can be configured,
+     * which will be overwritten by the `labelCol` set by `Form.Item`
+     * @defaultValue { span: 5, offset: 0 }
+     */
+    labelCol?: ColProps;
+    /**
+     * @zh
+     * 控件布局，同`labelCol`的设置方法一致，会覆盖全局的`wrapperCol`设置，[ColProps](/react/component/grid)
+     * @en
+     * The global control layout, which is the same as the setting method of `labelCol`,
+     * will be overwritten by the `wrapperCol` set by `Form.Item`
+     * @defaultValue { span: 19, offset: 0 }
+     */
+    wrapperCol?: ColProps;
+    /**
+     * @zh 是否在 required 的时候显示加重的红色星号，设置 position 可选择将星号置于 label 前/后
+     * @en Whether show red symbol when item is required，Set position props, you can choose to place the symbol before/after the label
+     * @defaultValue true
+     * @version `position` in 2.24.0
+     */
+    requiredSymbol?: boolean | {
+        position: 'start' | 'end';
+    };
+    /**
+     * @zh 标签的文本对齐方式
+     * @en Text alignment of `label`
+     * @defaultValue right
+     */
+    labelAlign?: 'left' | 'right';
+    /**
+     * @zh 设置表单初始值
+     * @en Default value of form data
+     */
+    initialValues?: Partial<FormData>;
+    /**
+     * @zh
+     * 触发验证的时机。
+     * @en
+     * When to trigger verification.
+     * @defaultValue onChange
+     * @version 2.28.0
+     */
+    validateTrigger?: string | string[];
+    /**
+     * @zh 任意表单项值改变时候触发。第一个参数是被改变表单项的值，第二个参数是所有的表单项值
+     * @en Callback when any form item value changes.The first is the changed value, and the second is the value of all items
+     */
+    onValuesChange?: (value: Partial<FormData>, values: Partial<FormData>) => void;
+    /**
+     * @zh 表单项值改变时候触发。和 onValuesChange 不同的是只会在用户操作表单项时触发
+     * @en Callback when the form item value changes. Unlike `onValuesChange`, it will only be called when the user manipulates the form item
+     */
+    onChange?: (value: Partial<FormData>, values: Partial<FormData>) => void;
+    /**
+     * @zh 配置最外层标签，可以是 html 标签或是组件
+     * @en Custom outer tag. Can be html tags or React component
+     * @defaultValue form
+     */
+    wrapper?: ComponentType;
+    /**
+     * @zh 配置 `wrapper` 之后，可以传一些参数到 wrapper 上。
+     * @en If set `wrapper`, You can pass some parameters to the wrapper.
+     */
+    wrapperProps?: IndexedObject;
+    /**
+     * @zh 统一配置表单控件是否可用
+     * @en Whether All Form item is disabled
+     */
+    disabled?: boolean;
+    /**
+     * @zh 是否显示标签后的一个冒号，优先级小于 `Form.Item` 中 `colon` 的优先级。(`ReactNode` in `v2.41.0`)
+     * @en Whether show colon after `label`. Priority is lower than `colon` in `Form.Item`.(`ReactNode` in `v2.41.0`)
+     */
+    colon?: boolean | ReactNode;
+    /**
+     * @zh 验证失败后滚动到第一个错误字段。(`ScrollIntoViewOptions` 类型在 `2.19.0` 开始支持)
+     * @en Whether scroll to first error item after validation fails. (`ScrollIntoViewOptions` is supported at `2.19.0`)
+     */
+    scrollToFirstError?: boolean | ScrollIntoViewOptions;
+    /**
+     * @zh 校验提示信息模板 [demo](/react/component/form#表单校验信息模板)
+     * @en validation prompt template [demo](/react/en-US/component/form#validate%20messages)
+     * @version 2.32.0
+     */
+    validateMessages?: Partial<{
+        [key in keyof ValidateMessagesTemplateType]: ValidateMessagesTemplateType[key] extends string ? ValidateMessagesTemplateType[key] | ((data: any, { label }: {
+            label: any;
+        }) => any) : Partial<Record<keyof ValidateMessagesTemplateType[key], string | ((data: any, { label }: {
+            label: any;
+        }) => any)>>;
+    }>;
+    /**
+     * @zh 数据验证成功后回调事件
+     * @en Callback when submit data
+     */
+    onSubmit?: (values: FormData) => void;
+    /**
+     * @zh 数据重置后回调事件
+     * @en Callback when reset data
+     */
+    onReset?: (values: FormData) => void;
+    /**
+     * @zh 数据验证失败后回调事件
+     * @en Callback when validate fail
+     * @version 2.21.0
+     */
+    onSubmitFailed?: (errors: {
+        [key: string]: FieldError;
+    }) => void;
+}
+export interface RulesProps<FieldValue = any> {
+    validateTrigger?: string | string[];
+    validateLevel?: 'error' | 'warning';
+    required?: boolean;
+    type?: string;
+    length?: number;
+    maxLength?: number;
+    minLength?: number;
+    includes?: boolean;
+    deepEqual?: any;
+    empty?: boolean;
+    min?: number;
+    max?: number;
+    equal?: number;
+    positive?: boolean;
+    negative?: boolean;
+    hasKeys?: string[];
+    match?: RegExp;
+    uppercase?: boolean;
+    lowercase?: boolean;
+    true?: boolean;
+    false?: boolean;
+    validator?: (value: FieldValue | undefined, callback: (error?: ReactNode) => void) => void;
+    message?: ReactNode;
+}
+export type FormItemChildrenFn<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> = (formData: any, form: FormInstance<FormData, FieldValue, FieldKey>) => React.ReactNode;
+/**
+ * @title Form.Item
+ */
+export interface FormItemProps<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> extends Omit<HTMLAttributes<any>, 'className' | 'children'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    prefixCls?: string;
+    store?: FormInstance<FormData, FieldValue, FieldKey>;
+    /**
+     * @zh 设置控件初始值.(初始值，请不要使用受控组件的defaultValue了)
+     * @en Default value
+     */
+    initialValue?: FieldValue;
+    /**
+     * @zh 受控组件的唯一标示
+     * @en Unique identification of controlled component
+     */
+    field?: FieldKey;
+    /**
+     * @zh 标签的文本
+     * @en Label text
+     */
+    label?: ReactNode;
+    /**
+     * @zh 提示文本
+     * @en Tooltip text
+     * @version 2.43.0
+     */
+    tooltip?: ReactNode | (TooltipProps & {
+        icon?: ReactElement;
+    });
+    /**
+     * @zh
+     * `<label>`标签布局，同[<Grid.Col>](/react/component/grid)组件接收的参数相同，可以配置`span`和`offset`值，会覆盖全局的`labelCol`设置
+     * @en
+     * The layout of `<label>`, the same as the props received by the `<Grid.Col>`.
+     * The values of `span` and `offset` can be configured, which will override the global `labelCol` setting
+     */
+    labelCol?: ColProps;
+    /**
+     * @zh 控件布局，同`labelCol`的设置方法一致，会覆盖全局的`wrapperCol`设置，[ColProps](/react/component/grid)
+     * @en The control layout, which is the same as the setting method of `labelCol`, which will override the global `wrapperCol` setting
+     */
+    wrapperCol?: ColProps;
+    /**
+     * @zh 是否显示标签后的一个冒号，优先级小于 `Form.Item` 中 `colon` 的优先级。(`ReactNode` in `v2.41.0`)
+     * @en Whether show colon after `label`. Priority is lower than `colon` in `Form.Item`.(`ReactNode` in `v2.41.0`)
+     */
+    colon?: boolean | ReactNode;
+    /**
+     * @zh 是否禁用，优先级高于 `Form` 的 `disabled` 属性
+     * @en Whether the FormItem is disabled. Priority is higher than the `disabled` prop of `Form`
+     */
+    disabled?: boolean;
+    /**
+     * @zh 受控模式下的验证规则，[RulesProps](#rules)
+     * @en Validation rules in controlled component, [RulesProps](#rules)
+     */
+    rules?: RulesProps<FieldValue>[];
+    /**
+     * @zh 接管子节点，搜集子节点值的时机。
+     * @en When to take over and collecting the child nodes.
+     * @defaultValue onChange
+     */
+    trigger?: string;
+    /**
+     * @zh 子节点被接管的值的属性名，默认是 `value`,比如 `<Checkbox>` 为 `checked`。
+     * @en The attribute name of the child node being taken over, default is `value`, ex, `<Checkbox>` is `checked`.
+     * @defaultValue value
+     */
+    triggerPropName?: string;
+    /**
+     * @zh 指定在子节点触发`onChange`事件时如何处理值。（如果自定义了`trigger`属性，那么这里的参数就是对应的事件回调函数的参数类型）
+     * @en Specify how to handle the value when the child node triggers the `onChange` event. (If the `trigger` attribute is customized, then the parameter here is the parameter type of the corresponding event callback function)
+     * @version 2.23.0
+     */
+    getValueFromEvent?: (...args: any[]) => FieldValue;
+    /**
+     * @zh
+     * 触发验证的时机。取值和跟包裹的控件有关系，控件支持的触发事件，都可以作为值。
+     * 例如`Input`支持的 `onFocus`、 `onBlur`、 `onChange` 都可以作为 `validateTrigger` 的值。传递为 `[]` 时，
+     * 仅会在调用表单 `validate` 方法时执行校验规则。
+     * @en
+     * When to trigger verification. The value is related to the wrapped item, and all events supported.
+     * For example, `onFocus`, `onBlur`, and `onChange` supported by `Input` can be used as the value of `validateTrigger`.
+     * When passed as `[]`, the validation rules will only be executed when the form `validate` method is called
+     * @defaultValue onChange
+     */
+    validateTrigger?: string | string[];
+    /**
+     * @zh
+     * 不渲染任何外部标签/样式，只进行字段绑定。**注意**: 设置该属性为true时，该字段若未通过校验，
+     * 错误信息将不会显示出来。可以传入对象，并设置 showErrorTip（ `2.5.0` 开始支持） 为true，错误信息将会展示在上层 formItem 节点下。
+     * @en
+     * No external tags/styles are rendered, only binding field. **Notice**: When set to true, if the field verification failed,
+     * the error message will not be displayed. You can pass in an object and set showErrorTip to true(Support at `2.5.0`),
+     * The error message will be displayed under the upper formItem node
+     */
+    noStyle?: boolean | {
+        showErrorTip: boolean;
+    };
+    /**
+     * @zh
+     * 是否必选，会在 `label` 标签前显示加重红色符号，如果这里不设置，会从 rules 中寻找是否是 required
+     * @en
+     * Whether the FormItem is Required, Will display an red symbol in front of the `label` label.
+     * If it is not set here, it will look for `required` from the rules
+     */
+    required?: boolean;
+    /**
+     * @zh 隐藏表单项. 表单字段值仍然会被获取
+     * @en hide the form item
+     * @version
+     */
+    hidden?: boolean;
+    /**
+     * @zh 额外的提示内容。
+     * @en Additional hint content.
+     */
+    extra?: ReactNode;
+    /**
+     * @zh 校验状态
+     * @en Validate status
+     */
+    validateStatus?: 'success' | 'warning' | 'error' | 'validating';
+    /**
+     * @zh 是否显示校验图标，配置 validateStatus 使用。
+     * @en Whether to show the verification icon, configure `validateStatus` to use.
+     */
+    hasFeedback?: boolean;
+    /**
+     * @zh 自定义校验文案
+     * @en Custom help text
+     */
+    help?: ReactNode;
+    /**
+     * @zh 将控件的 `value` 进行一定的转换再保存到form中。
+     * @en Convert the `value` to the FormItem
+     */
+    normalize?: (value: FieldValue | undefined, prevValue: FieldValue | undefined, allValues: Partial<FormData>) => any;
+    /**
+     * @zh 将Form内保存的当前控件对应的值进行一定的转换，再传递给控件。
+     * @en Convert the `value` of the FormItem to children;
+     * @version 2.23.0
+     */
+    formatter?: (value: FieldValue | undefined) => any;
+    /**
+     * @zh 设置依赖字段。当依赖的字段值改变时，触发自身的校验。如果是想动态渲染某个表单控件/表单区域，使用 shouldUpdate
+     * @en the dependency fields. When the value of the dependent field changes, trigger its own validation.If you want to dynamically render a form control/form area, use shouldUpdate
+     * @version 2.40.0
+     */
+    dependencies?: string[];
+    /**
+     * @zh 是否在其他控件值改变时候重新渲染当前区域。设置为true时候，表单的任意改变都会重新渲染该区域。
+     * @en Whether to re-render when other FormItem value change. When set to true, any changes to the Form will re-render.
+     */
+    shouldUpdate?: boolean | ((prevValues: Partial<FormData>, currentValues: Partial<FormData>, info: {
+        isFormList?: boolean;
+        field?: FieldKey | FieldKey[];
+        isInner?: boolean;
+    }) => boolean);
+    /**
+     * @zh 标签的文本对齐方式，优先级高于 `Form`
+     * @en Text alignment of `label`
+     * @defaultValue right
+     */
+    labelAlign?: 'left' | 'right';
+    /**
+     * @zh 布局
+     * @en The layout
+     */
+    layout?: 'horizontal' | 'vertical' | 'inline';
+    /**
+     * @zh 是否在 required 的时候显示加重的红色星号，设置 position 可选择将星号置于 label 前/后
+     * @en Whether show red symbol when item is required，Set position props, you can choose to place the symbol before/after the label
+     * @defaultValue true
+     * @version `position` in 2.24.0
+     */
+    requiredSymbol?: boolean | {
+        position: 'start' | 'end';
+    };
+    /**
+     * 内部使用属性，无需在文档上体现
+     */
+    isFormList?: boolean;
+    /**
+     * @zh `ReactNode` 类型与函数类型的 children
+     * @en `ReactNode` type and Fuction type children
+     */
+    children?: React.ReactNode | FormItemChildrenFn<FormData, FieldValue, FieldKey>;
+}
+export interface FormControlProps<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> {
+    /** 受控组件的唯一标示。 */
+    field?: FieldKey;
+    _key?: FieldKey;
+    initialValue?: FieldValue;
+    dependencies?: FormItemProps['dependencies'];
+    getValueFromEvent?: FormItemProps['getValueFromEvent'];
+    rules?: RulesProps<FieldValue>[];
+    /** 接管子节点，搜集子节点的时机 */
+    trigger?: string;
+    /** 子节点被接管的值的属性名，默认是`value`,比如`<Checkbox>`为`checked` */
+    triggerPropName?: string;
+    /** 触发验证的时机 */
+    validateTrigger?: string | string[];
+    /** 转换默认的 `value` 给控件。 */
+    normalize?: (value: FieldValue | undefined, prevValue: FieldValue | undefined, allValues: Partial<FormData>) => any;
+    formatter?: FormItemProps['formatter'];
+    onValuesChange?: (value: Partial<FormData>, values: Partial<FormData>) => void;
+    noStyle?: boolean;
+    shouldUpdate?: FormItemProps['shouldUpdate'];
+    disabled?: boolean;
+    validateStatus?: 'success' | 'warning' | 'error' | 'validating';
+    help?: ReactNode;
+    isFormList?: boolean;
+    hasFeedback?: boolean;
+    children?: ReactNode;
+}
+/**
+ * @title Form.List
+ */
+export interface FormListProps<SubFieldValue = any, SubFieldKey extends KeyType = string, FieldKey extends KeyType = string> {
+    /**
+     * @zh 字段名
+     * @en Field name
+     */
+    field: FieldKey;
+    /**
+     * @zh 初始值
+     * @en Default value
+     * @version 2.22.0
+     */
+    initialValue?: SubFieldValue[];
+    /**
+     * @zh FormItemProps['noStyle'].  `rules` 存在时默认为 `false`(需要渲染校验信息)，否则默认为 `true`
+     * @en FormItemProps['noStyle'].Defaults to `false` when `rules` exists (requires rendering validation information), otherwise defaults to `true`
+     * @version 2.46.0
+     */
+    noStyle?: FormItemProps['noStyle'];
+    /**
+     * @zh 受控模式下的验证规则，[RulesProps](#rules)
+     * @en Validation rules in controlled component, [RulesProps](#rules)
+     * @version 2.46.0
+     */
+    rules?: RulesProps<SubFieldValue[]>[];
+    /**
+     * @zh 函数类型的 children
+     * @en Function type children
+     */
+    children?: (fields: {
+        key: number;
+        field: SubFieldKey;
+    }[], operation: {
+        add: (defaultValue?: SubFieldValue, index?: number) => void;
+        remove: (index: number) => void;
+        move: (fromIndex: number, toIndex: number) => void;
+    }) => React.ReactNode;
+}
+export type FormContextProps<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> = Pick<FormProps<FormData, FieldValue, FieldKey>, 'prefixCls' | 'labelCol' | 'wrapperCol' | 'requiredSymbol' | 'labelAlign' | 'disabled' | 'colon' | 'layout' | 'validateTrigger'> & {
+    validateMessages?: FormProps['validateMessages'];
+    getFormElementId?: (field: FieldKey) => string;
+    store?: FormInstance<FormData, FieldValue, FieldKey>;
+};
+export type FormItemContextProps<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> = FormContextProps<FormData, FieldValue, FieldKey> & {
+    validateMessages?: FormProps['validateMessages'];
+    updateFormItem?: (field: string, params: {
+        errors?: FieldError<FieldValue>;
+        warnings?: ReactNode[];
+    }) => void;
+};
+export type FormInstance<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> = Pick<Store<FormData, FieldValue, FieldKey>, 'getFieldsValue' | 'getFieldValue' | 'getFieldError' | 'getFieldsError' | 'getTouchedFields' | 'getFields' | 'getInitialValues' | 'setInitialValues' | 'setInitialValue' | 'setFieldValue' | 'setFieldsValue' | 'setFields' | 'resetFields' | 'clearFields' | 'submit' | 'validate' | 'getFieldsState'> & {
+    scrollToField: (field: FieldKey, options?: ScrollIntoViewOptions) => void;
+    getInnerMethods: (inner?: boolean) => InnerMethodsReturnType<FormData, FieldValue, FieldKey>;
+};
+export type InnerMethodsReturnType<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> = Pick<Store<FormData, FieldValue, FieldKey>, 'registerField' | 'registerStateWatcher' | 'registerFormWatcher' | 'registerWatcher' | 'innerSetInitialValues' | 'innerSetInitialValue' | 'innerSetCallbacks' | 'innerSetFieldValue' | 'innerGetStore' | 'innerGetStoreStatus' | 'innerCollectFormState' | 'innerGetFieldValue'>;
+export interface ValidateOptions {
+    validateOnly?: boolean;
+}
+export interface FormValidateFn<FormData = any, FieldValue = FormData[keyof FormData], FieldKey extends KeyType = keyof FormData> {
+    /**
+     * 验证所有表单的值，并且返回报错和表单数据
+     */
+    (): Promise<FormData>;
+    /**
+     * 验证所有表单的值，并且返回报错和表单数据
+     * @param fields 需要校验的表单字段
+     */
+    (fields: FieldKey[]): Promise<Partial<FormData>>;
+    /**
+     * 校验配置
+     * @param options
+     */
+    (options: ValidateOptions): Promise<Partial<FormData>>;
+    /**
+     * 验证所有表单的值，并且返回报错和表单数据
+     * @param callback 校验完成后的回调函数
+     */
+    (callback: (errors?: ValidateFieldsErrors<FieldValue, FieldKey>, values?: FormData) => void): void;
+    /**
+     * 验证所有表单的值，并且返回报错和表单数据
+     * @param fields 需要校验的表单字段
+     * @param callback 校验完成后的回调函数
+     */
+    (fields: FieldKey[], callback: (errors?: ValidateFieldsErrors<FieldValue, FieldKey>, values?: Partial<FormData>) => void): void;
+    (fields: FieldKey[], options: ValidateOptions): Promise<Partial<FormData>>;
+    (options: ValidateOptions, callback: (errors?: ValidateFieldsErrors<FieldValue, FieldKey>, values?: Partial<FormData>) => void): void;
+    (fields: FieldKey[], options: ValidateOptions, callback: (errors?: ValidateFieldsErrors<FieldValue, FieldKey>, values?: Partial<FormData>) => void): void;
+}
+export declare const VALIDATE_STATUS: {
+    error: string;
+    success: string;
+    warning: string;
+    validating: string;
+};
+/**
+ * @title Form.Provider(`2.30.0`)
+ */
+export interface FormProviderProps {
+    /**
+     * @zh 包裹的任意 `Form` 组件的值改变时，该方法会被调用
+     * @en This method is called when the value of any wrapped `Form` component changes
+     */
+    onFormValuesChange?: (id: string | undefined, changedValues: any, { forms, }: {
+        forms: {
+            [key: string]: FormInstance;
+        };
+    }) => void;
+    /**
+     * @zh 包裹的任意 `Form` 组件触发提交时，该方法会被调用
+     * @en This method will be called when any wrapped `Form` component triggers a submit
+     */
+    onFormSubmit?: (id: string | undefined, values: any, { forms, }: {
+        forms: {
+            [key: string]: FormInstance;
+        };
+    }) => void;
+    onFormReset?: (id: string | undefined, values: any, { forms, }: {
+        forms: {
+            [key: string]: FormInstance;
+        };
+    }) => void;
+}
+export type FieldState<FieldValue = any> = {
+    errors: FieldError<FieldValue>[];
+    warnings: ReactNode[];
+    validateStatus: FormItemProps['validateStatus'] | undefined;
+    isSubmitting: boolean;
+    isTouched: boolean;
+};
+export declare enum SubmitStatus {
+    init = "init",
+    error = "error",
+    success = "success",
+    submitting = "submitting"
+}

package/types/{form → pc/form}/store.d.ts

@@ -4,6 +4,11 @@ import { SubmitStatus } from './interface';
 export type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
+/**
+ * setFieldValue: setFieldsValue, setFieldValue, setFields
+ * innerSetValue: such as Input change
+ * reset： 重置
+ */
 export type NotifyType = 'setFieldValue' | 'reset' | 'innerSetValue';
 export type innerCallbackType = 'onValuesChange' | 'onSubmit' | 'onReset' | 'onChange' | 'onSubmitFailed';
 export type StoreChangeInfo<T> = {
@@ -52,6 +57,11 @@ declare class Store<FormData = any, FieldValue = FormData[keyof FormData], Field
     private _inTouchFields;
     private _popTouchField;
     private _pushTouchField;
+    /**
+     *
+     * 内部使用，更新value，会同时触发onChange 和 onValuesChange
+     * @options.isFormList 强制更新field对应的组件包括其子组件,form
+     */
     innerSetFieldValue: (field: FieldKey, value: FieldValue, options?: {
         isFormList?: boolean;
         ignore?: boolean;