@hi-ui/form 4.3.0 → 4.3.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @hi-ui/form
 
+## 4.3.2
+
+### Patch Changes
+
+- [#3160](https://github.com/XiaoMi/hiui/pull/3160) [`3244e5a`](https://github.com/XiaoMi/hiui/commit/3244e5a94d1cfa3d85a65bc8804a21b8b60b80a4) Thanks [@zyprepare](https://github.com/zyprepare)! - <br>
+  - feat(form): 入口新增 FormLabel 组件导出
+  - feat(form): 更新 FormListProps 中 children 渲染函数中 fields 参数的类型
+
+## 4.3.1
+
+### Patch Changes
+
+- [#3121](https://github.com/XiaoMi/hiui/pull/3121) [`a6eb8cb`](https://github.com/XiaoMi/hiui/commit/a6eb8cbfda696dfeee147d6adba9805ecb8af5d0) Thanks [@zyprepare](https://github.com/zyprepare)! - fix(form): 更新 FormItemProps 的 children 类型以支持渲染函数，并修复 useForm 中对 formState 的引用问题 (#3120)
+
 ## 4.3.0
 
 ### Minor Changes

package/lib/cjs/index.js

@@ -18,6 +18,7 @@ var FormItem = require('./FormItem.js');
 var FormList = require('./FormList.js');
 var FormSubmit = require('./FormSubmit.js');
 var FormReset = require('./FormReset.js');
+var FormLabel = require('./FormLabel.js');
 var Form = Object.assign(Form$1.Form, {
   Item: FormItem.FormItem,
   List: FormList.FormList,
@@ -30,4 +31,5 @@ exports.FormItem = FormItem.FormItem;
 exports.FormList = FormList.FormList;
 exports.FormSubmit = FormSubmit.FormSubmit;
 exports.FormReset = FormReset.FormReset;
+exports.FormLabel = FormLabel.FormLabel;
 exports["default"] = Form;

package/lib/cjs/use-form.js

@@ -430,7 +430,7 @@ var useForm = function useForm(_a) {
                   var promiseOrUndefined;
                   try {
                     // @ts-ignore
-                    promiseOrUndefined = onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(formState.values);
+                    promiseOrUndefined = onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(formStateRef.current.values);
                   } catch (error) {
                     formDispatch({
                       type: 'SUBMIT_DONE'
@@ -442,7 +442,7 @@ var useForm = function useForm(_a) {
                       type: 'SUBMIT_DONE'
                     });
                     // return combinedErrors
-                    return formState.values;
+                    return formStateRef.current.values;
                   }
                   return Promise.resolve(promiseOrUndefined).then(function (result) {
                     formDispatch({
@@ -450,7 +450,7 @@ var useForm = function useForm(_a) {
                     });
                     // return result
                     // TODO: 满足promise 如果既给到values 又给到 errors
-                    return formState.values;
+                    return formStateRef.current.values;
                   })["catch"](function (_errors) {
                     formDispatch({
                       type: 'SUBMIT_DONE'
@@ -480,7 +480,7 @@ var useForm = function useForm(_a) {
         }
       }, _callee3);
     }));
-  }, [formState, onSubmit, validateAll]);
+  }, [formStateRef, onSubmit, validateAll]);
   var handleSubmit = React.useCallback(function (evt) {
     domUtils.stopEvent(evt);
     return submitForm();

package/lib/esm/index.js

@@ -14,6 +14,7 @@ import { FormItem } from './FormItem.js';
 import { FormList } from './FormList.js';
 import { FormSubmit } from './FormSubmit.js';
 import { FormReset } from './FormReset.js';
+export { FormLabel } from './FormLabel.js';
 var Form = Object.assign(Form$1, {
   Item: FormItem,
   List: FormList,

package/lib/esm/use-form.js

@@ -417,7 +417,7 @@ var useForm = function useForm(_a) {
                   var promiseOrUndefined;
                   try {
                     // @ts-ignore
-                    promiseOrUndefined = onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(formState.values);
+                    promiseOrUndefined = onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(formStateRef.current.values);
                   } catch (error) {
                     formDispatch({
                       type: 'SUBMIT_DONE'
@@ -429,7 +429,7 @@ var useForm = function useForm(_a) {
                       type: 'SUBMIT_DONE'
                     });
                     // return combinedErrors
-                    return formState.values;
+                    return formStateRef.current.values;
                   }
                   return Promise.resolve(promiseOrUndefined).then(function (result) {
                     formDispatch({
@@ -437,7 +437,7 @@ var useForm = function useForm(_a) {
                     });
                     // return result
                     // TODO: 满足promise 如果既给到values 又给到 errors
-                    return formState.values;
+                    return formStateRef.current.values;
                   })["catch"](function (_errors) {
                     formDispatch({
                       type: 'SUBMIT_DONE'
@@ -467,7 +467,7 @@ var useForm = function useForm(_a) {
         }
       }, _callee3);
     }));
-  }, [formState, onSubmit, validateAll]);
+  }, [formStateRef, onSubmit, validateAll]);
   var handleSubmit = useCallback(function (evt) {
     stopEvent(evt);
     return submitForm();

package/lib/types/FormItem.d.ts

@@ -6,7 +6,7 @@ export interface FormItemProps extends UseFormFieldProps, FormLabelProps {
     /**
      * 表单控件或其渲染函数
      */
-    children?: React.ReactNode;
+    children?: React.ReactNode | ((props: Record<string, any>) => React.ReactNode);
     /**
      * 支持表单控件 render 渲染
      */

package/lib/types/FormList.d.ts

@@ -1,12 +1,28 @@
 import React from 'react';
 import { HiBaseHTMLProps } from '@hi-ui/core';
 import { FormFieldPath, FormListChildrenAction, FormListHelper } from './types';
+declare const fieldListSymbol: unique symbol;
 export declare const FormList: React.ForwardRefExoticComponent<FormListProps & React.RefAttributes<HTMLDivElement | null>>;
+export interface FormListChildField {
+    /**
+     * 字段名
+     * - 实际上是元素在数组中的索引
+     */
+    name: string;
+    /**
+     * 字段符号
+     */
+    symbol: typeof fieldListSymbol;
+    /**
+     * 字段值
+     */
+    value: unknown;
+}
 export interface FormListProps extends HiBaseHTMLProps<'div'> {
     /**
      * 表单控件渲染函数
      */
-    children?: (fields: any[], action: FormListChildrenAction) => React.ReactElement;
+    children?: (fields: FormListChildField[], action: FormListChildrenAction) => React.ReactElement;
     /**
      * 列表名称
      */
@@ -16,3 +32,4 @@ export interface FormListProps extends HiBaseHTMLProps<'div'> {
      */
     innerRef?: React.Ref<FormListHelper>;
 }
+export {};

package/lib/types/index.d.ts

@@ -12,4 +12,5 @@ export * from './FormItem';
 export * from './FormList';
 export * from './FormSubmit';
 export * from './FormReset';
+export * from './FormLabel';
 export * from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hi-ui/form",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "A sub-package for @hi-ui/hiui.",
   "keywords": [],
   "author": "HiUI <mi-hiui@xiaomi.com>",