@qsxy/element-plus-react 1.0.0-next.2 → 1.0.0-next.21

package/dist/Form/FormItemContext.js

@@ -1,32 +1,4 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/Form/FormItemContext.ts
-var FormItemContext_exports = {};
-__export(FormItemContext_exports, {
-  FormItemContext: () => FormItemContext
-});
-module.exports = __toCommonJS(FormItemContext_exports);
-var import_react = require("react");
-var FormItemContext = (0, import_react.createContext)({
+import { createContext } from 'react';
+export var FormItemContext = /*#__PURE__*/createContext({
   size: null
-});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  FormItemContext
-});
+});

package/dist/Form/List.js

@@ -1,142 +1,159 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/Form/List.tsx
-var List_exports = {};
-__export(List_exports, {
-  default: () => List_default
-});
-module.exports = __toCommonJS(List_exports);
-var import_react = __toESM(require("react"));
-var import_Util = require("../Util");
-var import_FieldContext = __toESM(require("./FieldContext"));
-var import_FormItem = __toESM(require("./FormItem"));
-var import_ListContext = __toESM(require("./ListContext"));
-var import_valueUtil = require("./utils/valueUtil");
-var List = ({ name, initialValue, children, rules, validateTrigger }) => {
-  const context = (0, import_react.useContext)(import_FieldContext.default);
-  const keyRef = (0, import_react.useRef)({
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+import React, { useContext, useMemo, useRef } from 'react';
+import { warning } from "../Util";
+import FieldContext from "./FieldContext";
+import FormItem from "./FormItem";
+import ListContext from "./ListContext";
+import { getNamePath, move as _move } from "./utils/valueUtil";
+var List = function List(_ref) {
+  var name = _ref.name,
+    initialValue = _ref.initialValue,
+    children = _ref.children,
+    rules = _ref.rules,
+    validateTrigger = _ref.validateTrigger;
+  var context = useContext(FieldContext);
+  var keyRef = useRef({
     keys: [],
     id: 0
   });
-  const keyManager = keyRef.current;
-  const prefixName = (0, import_react.useMemo)(() => {
-    const parentPrefixName = (0, import_valueUtil.getNamePath)(context.prefixName) || [];
-    return [...parentPrefixName, ...(0, import_valueUtil.getNamePath)(name)];
+  var keyManager = keyRef.current;
+  var prefixName = useMemo(function () {
+    var parentPrefixName = getNamePath(context.prefixName) || [];
+    return [].concat(_toConsumableArray(parentPrefixName), _toConsumableArray(getNamePath(name)));
   }, [context.prefixName, name]);
-  const fieldContext = (0, import_react.useMemo)(() => ({ ...context, prefixName }), [context, prefixName]);
-  const listContext = (0, import_react.useMemo)(
-    () => ({
-      getKey: (namePath) => {
-        const len = prefixName.length;
-        const pathName = namePath[len];
+  var fieldContext = useMemo(function () {
+    return _objectSpread(_objectSpread({}, context), {}, {
+      prefixName: prefixName
+    });
+  }, [context, prefixName]);
+
+  // List context
+  var listContext = useMemo(function () {
+    return {
+      getKey: function getKey(namePath) {
+        var len = prefixName.length;
+        var pathName = namePath[len];
         return [keyManager.keys[pathName], namePath.slice(len + 1)];
       }
-    }),
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [prefixName]
-  );
-  if (typeof children !== "function") {
-    (0, import_Util.warning)(false, "Form.List only accepts function as children.");
+    };
+  },
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  [prefixName]);
+
+  // User should not pass `children` as other type.
+  if (typeof children !== 'function') {
+    warning(false, 'Form.List only accepts function as children.');
     return null;
   }
-  const shouldUpdate = (prevValue, nextValue, { source }) => {
-    if (source === "internal") {
+  var shouldUpdate = function shouldUpdate(prevValue, nextValue, _ref2) {
+    var source = _ref2.source;
+    if (source === 'internal') {
       return false;
     }
     return prevValue !== nextValue;
   };
-  return /* @__PURE__ */ import_react.default.createElement(import_ListContext.default.Provider, { value: listContext }, /* @__PURE__ */ import_react.default.createElement(import_FieldContext.default.Provider, { value: fieldContext }, /* @__PURE__ */ import_react.default.createElement(import_FormItem.default, { name: [], shouldUpdate, rules, validateTrigger, initialValue, isList: true }, ({ value = [], onChange }, meta) => {
-    const { getFieldValue } = context;
-    const getNewValue = () => {
-      const values = getFieldValue(prefixName || []);
+  return /*#__PURE__*/React.createElement(ListContext.Provider, {
+    value: listContext
+  }, /*#__PURE__*/React.createElement(FieldContext.Provider, {
+    value: fieldContext
+  }, /*#__PURE__*/React.createElement(FormItem, {
+    name: [],
+    shouldUpdate: shouldUpdate,
+    rules: rules,
+    validateTrigger: validateTrigger,
+    initialValue: initialValue,
+    isList: true
+  }, function (_ref3, meta) {
+    var _ref3$value = _ref3.value,
+      value = _ref3$value === void 0 ? [] : _ref3$value,
+      onChange = _ref3.onChange;
+    var getFieldValue = context.getFieldValue;
+    var getNewValue = function getNewValue() {
+      var values = getFieldValue(prefixName || []);
       return values || [];
     };
-    const operations = {
-      add: (defaultValue, index) => {
-        const newValue = getNewValue();
+
+    /**
+     * Always get latest value in case user update fields by `form` api.
+     */
+    var operations = {
+      add: function add(defaultValue, index) {
+        // Mapping keys
+        var newValue = getNewValue();
         if (index >= 0 && index <= newValue.length) {
-          keyManager.keys = [...keyManager.keys.slice(0, index), keyManager.id, ...keyManager.keys.slice(index)];
-          onChange([...newValue.slice(0, index), defaultValue, ...newValue.slice(index)]);
+          keyManager.keys = [].concat(_toConsumableArray(keyManager.keys.slice(0, index)), [keyManager.id], _toConsumableArray(keyManager.keys.slice(index)));
+          onChange([].concat(_toConsumableArray(newValue.slice(0, index)), [defaultValue], _toConsumableArray(newValue.slice(index))));
         } else {
-          if (process.env.NODE_ENV !== "production" && (index < 0 || index > newValue.length)) {
-            (0, import_Util.warning)(false, "The second parameter of the add function should be a valid positive number.");
+          if (process.env.NODE_ENV !== 'production' && (index < 0 || index > newValue.length)) {
+            warning(false, 'The second parameter of the add function should be a valid positive number.');
           }
-          keyManager.keys = [...keyManager.keys, keyManager.id];
-          onChange([...newValue, defaultValue]);
+          keyManager.keys = [].concat(_toConsumableArray(keyManager.keys), [keyManager.id]);
+          onChange([].concat(_toConsumableArray(newValue), [defaultValue]));
         }
         keyManager.id += 1;
       },
-      remove: (index) => {
-        const newValue = getNewValue();
-        const indexSet = new Set(Array.isArray(index) ? index : [index]);
+      remove: function remove(index) {
+        var newValue = getNewValue();
+        var indexSet = new Set(Array.isArray(index) ? index : [index]);
         if (indexSet.size <= 0) {
           return;
         }
-        keyManager.keys = keyManager.keys.filter((_, keysIndex) => !indexSet.has(keysIndex));
-        onChange(newValue.filter((_, valueIndex) => !indexSet.has(valueIndex)));
+        keyManager.keys = keyManager.keys.filter(function (_, keysIndex) {
+          return !indexSet.has(keysIndex);
+        });
+
+        // Trigger store change
+        onChange(newValue.filter(function (_, valueIndex) {
+          return !indexSet.has(valueIndex);
+        }));
       },
-      move(from, to) {
+      move: function move(from, to) {
         if (from === to) {
           return;
         }
-        const newValue = getNewValue();
+        var newValue = getNewValue();
+
+        // Do not handle out of range
         if (from < 0 || from >= newValue.length || to < 0 || to >= newValue.length) {
           return;
         }
-        keyManager.keys = (0, import_valueUtil.move)(keyManager.keys, from, to);
-        onChange((0, import_valueUtil.move)(newValue, from, to));
+        keyManager.keys = _move(keyManager.keys, from, to);
+
+        // Trigger store change
+        onChange(_move(newValue, from, to));
       }
     };
-    let listValue = value || [];
+    var listValue = value || [];
     if (!Array.isArray(listValue)) {
       listValue = [];
-      if (process.env.NODE_ENV !== "production") {
-        (0, import_Util.warning)(false, `Current value of '${prefixName.join(" > ")}' is not an array type.`);
+      if (process.env.NODE_ENV !== 'production') {
+        warning(false, "Current value of '".concat(prefixName.join(' > '), "' is not an array type."));
       }
     }
-    return children(
-      listValue.map((__, index) => {
-        let key = keyManager.keys[index];
-        if (key === void 0) {
-          keyManager.keys[index] = keyManager.id;
-          key = keyManager.keys[index];
-          keyManager.id += 1;
-        }
-        return {
-          name: index,
-          key,
-          isListField: true
-        };
-      }),
-      operations,
-      meta
-    );
+    return children(listValue.map(function (__, index) {
+      var key = keyManager.keys[index];
+      if (key === undefined) {
+        keyManager.keys[index] = keyManager.id;
+        key = keyManager.keys[index];
+        keyManager.id += 1;
+      }
+      return {
+        name: index,
+        key: key,
+        isListField: true
+      };
+    }), operations, meta);
   })));
 };
-var List_default = List;
+export default List;

package/dist/Form/ListContext.js

@@ -1,27 +1,3 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/Form/ListContext.ts
-var ListContext_exports = {};
-__export(ListContext_exports, {
-  default: () => ListContext_default
-});
-module.exports = __toCommonJS(ListContext_exports);
-var import_react = require("react");
-var ListContext = (0, import_react.createContext)(null);
-var ListContext_default = ListContext;
+import { createContext } from 'react';
+var ListContext = /*#__PURE__*/createContext(null);
+export default ListContext;

package/dist/Form/index.js

@@ -1,45 +1,3 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/Form/index.ts
-var Form_exports = {};
-__export(Form_exports, {
-  Form: () => import_Form.default,
-  FormItemContext: () => import_FormItemContext.FormItemContext,
-  useForm: () => import_useForm.default
-});
-module.exports = __toCommonJS(Form_exports);
-var import_Form = __toESM(require("./Form"));
-var import_FormItemContext = require("./FormItemContext");
-var import_useForm = __toESM(require("./useForm"));
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Form,
-  FormItemContext,
-  useForm
-});
+export { default as Form } from "./Form";
+export { FormItemContext } from "./FormItemContext";
+export { default as useForm } from "./useForm";

package/dist/Form/typings.d.ts

@@ -1,16 +1,20 @@
-import React, { ComponentClass, FC } from 'react';
+import React, { ComponentClass, FC, RefObject } from 'react';
 import type { Options as ScrollOptions } from 'scroll-into-view-if-needed';
 import { BaseProps, ComponentChildren, NativeProps, TypeAttributes } from '../types/common';
+import { InternalFieldProps } from './FormItem';
 type BaseFormProps = Omit<React.AllHTMLAttributes<HTMLFormElement>, 'onSubmit' | 'form' | 'size' | 'children'>;
 type RenderProps = (values: Store, form: FormInstance) => React.ReactElement;
-export type FormRules = Record<string, Rule[]>;
-export interface FormProps<Values = any> extends BaseFormProps {
+export type FormRules = Record<string, Rule[] | Record<string, Rule[]>>;
+export interface FormProps<Values = Store> extends BaseFormProps {
+    /** 经 Form.useForm() 创建的 form 控制实例，不提供时会自动创建 */
     form?: FormInstance<Values>;
     children?: RenderProps | ComponentChildren;
     component?: false | string | FC<any> | ComponentClass<any, any>;
     fields?: FieldData[];
+    /** 表单验证规则 */
     rules?: FormRules;
     name?: string;
+    /** 验证提示模板 */
     validateMessages?: ValidateMessages;
     onValuesChange?: Callbacks<Values>['onValuesChange'];
     onFieldsChange?: Callbacks<Values>['onFieldsChange'];
@@ -18,31 +22,66 @@ export interface FormProps<Values = any> extends BaseFormProps {
     onFinishFailed?: Callbacks<Values>['onFinishFailed'];
     validateTrigger?: string | string[] | false;
     preserve?: boolean;
+    /** 配置 Form.Item 的 colon 的默认值。表示是否显示 label 后面的冒号 */
     colon?: boolean;
-    initialValues?: Store;
+    /** 表单默认值，只有初始化以及重置时生效 */
+    initialValues?: Values;
+    /** 表单域标签的位置， 如果值为 left 或者 right 时，则需要设置 label-width */
     labelPosition?: 'left' | 'right' | 'top';
+    /** 表单域标签的宽度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 支持 auto。 */
     labelWidth?: string | number;
+    /** 行内表单模式 */
     inline?: boolean;
+    /** 是否宽度100% */
     flat?: boolean;
+    /** 是否只读 */
     disabled?: boolean;
+    /** 用于控制该表单内组件的尺寸 */
     size?: TypeAttributes.Size;
+    /** 是否隐藏必填字段标签旁边的红色星号。 */
+    hideRequiredAsterisk?: boolean;
+    /** 星号的位置。 */
+    requireAsteriskPosition?: 'left' | 'right';
+    /** 是否显示校验错误信息 */
+    showMessage?: boolean;
+    /** 当校验失败时，滚动到第一个错误表单项 */
+    scrollToError?: boolean;
     onChange?: (model: any) => void;
     formStyle?: React.CSSProperties;
     className?: string;
 }
 export interface FormItemProps<T> extends BaseProps, NativeProps {
+    /**
+     * 配合 label 属性使用，表示是否显示 label 后面的冒号
+     */
     colon?: boolean;
+    /** label 标签的文本 */
     label?: boolean | string | React.ReactElement;
+    /** 用于控制该表单内组件的尺寸 */
     size?: TypeAttributes.Size;
+    /** 标签的长度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 可以使用 auto。 */
     labelWidth?: string | number;
+    /** 表单域标签的位置， 如果值为 left 或者 right 时，则需要设置 label-width */
+    labelPosition?: 'left' | 'right' | 'top';
+    /** 必填样式设置。如不设置，则会根据校验规则自动生成 */
     required?: boolean;
+    /** 为 true 时不带样式，作为纯字段控件使用 */
     noStyle?: boolean;
+    /** 校验状态，如不设置，则会根据校验规则自动生成，可选：'success' 'warning' 'error' 'validating' */
     validateStatus?: 'success' | 'warning' | 'error' | 'validating';
+    /** 配置提示信息 */
     help?: string | React.ReactElement;
+    /** 是否标签宽度为0，等用于`labelWidth={0}`，如果同时设置了labelWidth，则此配置无效 */
     pure?: boolean;
+    /** 是否居中 */
     center?: boolean;
+    /** 是否显示校验错误信息 */
+    showMessage?: boolean;
+    /** 文本自定义内联样式 */
     labelStyle?: React.CSSProperties;
+    /** 校验失败文本自定义内联样式 */
     errorStyle?: React.CSSProperties;
+    /** 校验警告自定义内联样式 */
     warningStyle?: React.CSSProperties;
 }
 export interface FieldEntity {
@@ -58,13 +97,14 @@ export interface FieldEntity {
     getNamePath: () => InternalNamePath;
     getErrors: () => string[];
     getWarnings: () => string[];
+    containerRef?: RefObject<HTMLDivElement>;
     props: {
         label?: string | boolean | React.ReactElement<any>;
         name?: NamePath;
         rules?: Rule[];
         dependencies?: NamePath[];
         initialValue?: any;
-    };
+    } & InternalFieldProps;
 }
 interface UpdateAction {
     type: 'updateValue';
@@ -91,6 +131,9 @@ export interface Meta {
 export interface InternalFieldData extends Meta {
     value: StoreValue;
 }
+/**
+ * Used by `setFields` config
+ */
 export interface FieldData extends Partial<Omit<InternalFieldData, 'name'>> {
     name: NamePath;
 }
@@ -115,6 +158,7 @@ interface BaseRule {
     transform?: (value: StoreValue) => StoreValue;
     type?: RuleType;
     whitespace?: boolean;
+    /** Customize rule level `validateTrigger`. Must be subset of Field `validateTrigger` */
     validateTrigger?: string | string[];
     phone?: boolean;
 }
@@ -166,6 +210,10 @@ export interface ValidateOptions {
     label?: string | boolean | React.ReactElement<{}>;
     triggerName?: string;
     validateMessages?: ValidateMessages;
+    /**
+     * Recursive validate. It will validate all the name path that contains the provided one.
+     * e.g. ['a'] will validate ['a'] , ['a', 'b'] and ['a', 1].
+     */
     recursive?: boolean;
 }
 export type InternalValidateFields<Values = any> = (nameList?: NamePath[], options?: ValidateOptions) => Promise<Values>;
@@ -189,6 +237,11 @@ interface SetFieldInfo {
 }
 interface DependenciesUpdateInfo {
     type: 'dependenciesUpdate';
+    /**
+     * Contains all the related `InternalNamePath[]`.
+     * a <- b <- c : change `a`
+     * relatedFields=[a, b, c]
+     */
     relatedFields: InternalNamePath[];
 }
 export type NotifyInfo = ValueUpdateInfo | ValidateFinishInfo | ResetInfo | RemoveInfo | SetFieldInfo | DependenciesUpdateInfo;
@@ -216,6 +269,7 @@ export interface InternalHooks {
     setPreserve: (preserve?: boolean) => void;
     getInitialValue: (namePath: InternalNamePath) => StoreValue;
 }
+/** Only return partial when type is not any */
 type RecursivePartial<T> = T extends object ? {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
 } : any;
@@ -239,16 +293,38 @@ export interface FormInstance<Values = any> {
 }
 export type InternalFormInstance = Omit<FormInstance, 'validateFields'> & {
     validateFields: InternalValidateFields;
+    /**
+     * Passed by field context props
+     */
     prefixName?: InternalNamePath;
     validateTrigger?: string | string[] | false;
+    /**
+     * Form component should register some content into store.
+     * We pass the `HOOK_MARK` as key to avoid user call the function.
+     */
     getInternalHooks: (secret: string) => InternalHooks | null;
+    /** @private Internal usage. Do not use it in your production */
     _init?: boolean;
+    /** 配置 Form.Item 的 colon 的默认值。表示是否显示 label 后面的冒号 */
     colon?: boolean;
+    /** 是否禁用该表单内的所有组件。 如果设置为 true, 它将覆盖内部组件的 disabled 属性 */
     disabled?: boolean;
+    /** 表单域标签的位置， 如果值为 left 或者 right 时，则需要设置 label-width */
     labelPosition?: 'left' | 'right' | 'top';
+    /** 标签宽度，例如 '50px'。 可以使用 auto。 */
     labelWidth?: string | number;
+    /** 用于控制该表单域下组件的默认尺寸 */
     size?: TypeAttributes.Size;
+    /** 表单验证规则 */
     rules?: FormRules;
+    /** 是否隐藏必填字段标签旁边的红色星号。 */
+    hideRequiredAsterisk?: boolean;
+    /** 星号的位置。 */
+    requireAsteriskPosition?: 'left' | 'right';
+    /** 是否显示校验错误信息 */
+    showMessage?: boolean;
+    /** 当校验失败时，滚动到第一个错误表单项 */
+    scrollToError?: boolean;
 };
 export type EventArgs = any[];
 type ValidateMessage = string | (() => string);

package/dist/Form/typings.js

@@ -1,17 +1 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/Form/typings.ts
-var typings_exports = {};
-module.exports = __toCommonJS(typings_exports);
+export {};

package/dist/Form/useForm.d.ts

@@ -26,7 +26,14 @@ export declare class FormStore {
     private scrollToField;
     private getInternalHooks;
     private useSubscribe;
+    /**
+     * Record prev Form unmount fieldEntities which config preserve false.
+     * This need to be refill with initialValues instead of store value.
+     */
     private prevWithoutPreserves;
+    /**
+     * First time `setInitialValues` should update store with initial value
+     */
     private setInitialValues;
     private destroyForm;
     private getInitialValue;
@@ -39,6 +46,10 @@ export declare class FormStore {
     private timeoutId;
     private warningUnhooked;
     private updateStore;
+    /**
+     * Get registered field entities.
+     * @param pure Only return field which has a `name`. Default: false
+     */
     private getFieldEntities;
     private getFieldsMap;
     private getFieldEntitiesForNamePathList;
@@ -51,15 +62,26 @@ export declare class FormStore {
     private isFieldTouched;
     private isFieldsValidating;
     private isFieldValidating;
+    /**
+     * Reset Field with field `initialValue` prop.
+     * Can pass `entities` or `namePathList` or just nothing.
+     */
     private resetWithFieldInitialValue;
     private resetFields;
     private setFields;
     private getFields;
+    /**
+     * This only trigger when a field is on constructor to avoid we get initialValue too late
+     */
     private initEntityValue;
     private isMergedPreserve;
     private registerField;
     private dispatch;
     private notifyObservers;
+    /**
+     * Notify dependencies children with parent update
+     * We need delay to trigger validate in case Field is under render props
+     */
     private triggerDependenciesUpdate;
     private updateValue;
     private setFieldsValue;