@hi-ui/form 4.0.9 → 4.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @hi-ui/form
+
+## 4.1.0
+
+### Minor Changes
+
+- [#2336](https://github.com/XiaoMi/hiui/pull/2336) [`bb2de106e`](https://github.com/XiaoMi/hiui/commit/bb2de106ee471f47a6f7223b6297e707f42d0278) Thanks [@zyprepare](https://github.com/zyprepare)! - FormList 对外暴露内部 add remove 等方法

package/lib/cjs/FormList.js

@@ -38,9 +38,10 @@ var fieldListSymbol = Symbol('field-list');
  * TODO: What is FormList
  */
 
-var FormList = function FormList(_ref) {
+var FormList = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,
-      nameProp = _ref.name;
+      nameProp = _ref.name,
+      innerRef = _ref.innerRef;
 
   var _useFormContext = context.useFormContext(),
       values = _useFormContext.values,
@@ -128,7 +129,17 @@ var FormList = function FormList(_ref) {
         value: value
       };
     });
-  }, [values, name]);
+  }, [values, name]); // @ts-ignore
+
+  React.useImperativeHandle(innerRef, function () {
+    return {
+      add: add,
+      remove: remove,
+      insertBefore: insertBefore,
+      swap: swap,
+      move: move
+    };
+  });
 
   if (typeof children !== 'function') {
     if (env.__DEV__) {
@@ -145,7 +156,7 @@ var FormList = function FormList(_ref) {
     insertBefore: insertBefore,
     move: move
   });
-};
+});
 
 if (env.__DEV__) {
   FormList.displayName = 'FormList';

package/lib/esm/FormList.js

@@ -7,7 +7,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
+import React, { forwardRef, useImperativeHandle } from 'react';
 import { __DEV__ } from '@hi-ui/env';
 import { useFormContext } from './context.js';
 import { setNested, getNested } from '@hi-ui/object-utils';
@@ -17,9 +17,10 @@ var fieldListSymbol = Symbol('field-list');
  * TODO: What is FormList
  */
 
-var FormList = function FormList(_ref) {
+var FormList = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var children = _ref.children,
-      nameProp = _ref.name;
+      nameProp = _ref.name,
+      innerRef = _ref.innerRef;
 
   var _useFormContext = useFormContext(),
       values = _useFormContext.values,
@@ -107,7 +108,17 @@ var FormList = function FormList(_ref) {
         value: value
       };
     });
-  }, [values, name]);
+  }, [values, name]); // @ts-ignore
+
+  useImperativeHandle(innerRef, function () {
+    return {
+      add: add,
+      remove: remove,
+      insertBefore: insertBefore,
+      swap: swap,
+      move: move
+    };
+  });
 
   if (typeof children !== 'function') {
     if (__DEV__) {
@@ -124,7 +135,7 @@ var FormList = function FormList(_ref) {
     insertBefore: insertBefore,
     move: move
   });
-};
+});
 
 if (__DEV__) {
   FormList.displayName = 'FormList';

package/lib/types/FormList.d.ts

@@ -1,10 +1,11 @@
 import React from 'react';
-import { FormFieldPath, FormListChildrenAction } from './types';
+import { HiBaseHTMLProps } from '@hi-ui/core';
+import { FormFieldPath, FormListChildrenAction, FormListHelper } from './types';
 /**
  * TODO: What is FormList
  */
-export declare const FormList: React.FC<FormListProps>;
-export interface FormListProps {
+export declare const FormList: React.ForwardRefExoticComponent<FormListProps & React.RefAttributes<HTMLDivElement | null>>;
+export interface FormListProps extends HiBaseHTMLProps<'div'> {
     /**
      * 表单控件渲染函数
      */
@@ -13,4 +14,8 @@ export interface FormListProps {
      * 列表名称
      */
     name: FormFieldPath;
+    /**
+     * 提供辅助方法的内部引用
+     */
+    innerRef?: React.Ref<FormListHelper>;
 }

package/lib/types/index.d.ts

@@ -2,7 +2,7 @@
 import './styles/index.scss';
 declare const Form: import("react").ForwardRefExoticComponent<import("./Form").FormProps<Record<string, any>> & import("react").RefAttributes<HTMLFormElement | null>> & {
     Item: import("react").FC<import("./FormItem").FormItemProps>;
-    List: import("react").FC<import("./FormList").FormListProps>;
+    List: import("react").ForwardRefExoticComponent<import("./FormList").FormListProps & import("react").RefAttributes<HTMLDivElement | null>>;
     Submit: import("react").ForwardRefExoticComponent<import("./FormSubmit").FormSubmitProps & import("react").RefAttributes<HTMLAnchorElement | HTMLButtonElement | null>>;
     Reset: import("react").ForwardRefExoticComponent<import("./FormReset").FormResetProps & import("react").RefAttributes<HTMLButtonElement | null>>;
 };

package/lib/types/types.d.ts

@@ -125,6 +125,28 @@ export interface FormHelpers<T = any> {
      */
     clearFieldValidate: (fields: FormFieldPath) => void;
 }
+export interface FormListHelper {
+    /**
+     * 动态添加表单
+     */
+    add: (value: any) => void;
+    /**
+     * 动态删除表单
+     */
+    remove: (index: number) => void;
+    /**
+     * 在 index 之前插入
+     */
+    insertBefore: (index: number, value: any) => void;
+    /**
+     * 置换表单值
+     */
+    swap: (aIndex: number, bIndex: number) => void;
+    /**
+     * 移动表单值
+     */
+    move: (fromIndex: number, toIndex: number) => void;
+}
 export declare type FormFieldPath = (string | number)[] | string | number;
 export declare type FormErrorMessage = string;
 export declare type FormRules = Record<string, FormRuleModel[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hi-ui/form",
-  "version": "4.0.9",
+  "version": "4.1.0",
   "description": "A sub-package for @hi-ui/hiui.",
   "keywords": [],
   "author": "HiUI <mi-hiui@xiaomi.com>",
@@ -65,6 +65,5 @@
     "@hi-ui/hi-build": "^4.0.1",
     "react": "^17.0.1",
     "react-dom": "^17.0.1"
-  },
-  "gitHead": "619fb2b1774e927c016d9e58117fd4bf0d0364f3"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 Xiaomi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.