musae 1.3.1-beta.19 → 1.3.1-beta.20

package/dist/components/form/field/field.cjs

@@ -14,7 +14,7 @@ var className = require('@aiszlab/relax/class-name');
 var context = require('../context.cjs');
 var index = require('../hooks/index.cjs');
 
-var _excluded = ["required", "children", "className", "style", "supporting", "error", "name", "rules"];
+var _excluded = ["required", "children", "className", "style", "supporting", "name", "rules"];
 /**
  * @description
  * form item may not has name prop
@@ -26,7 +26,6 @@ var Field = function Field(_ref) {
     className$1 = _ref.className,
     style = _ref.style,
     supporting$1 = _ref.supporting,
-    renderError = _ref.error,
     name = _ref.name,
     rules = _ref.rules,
     props = _objectWithoutProperties(_ref, _excluded);
@@ -57,13 +56,14 @@ var Field = function Field(_ref) {
       })), true];
     }, [[], false]).at(0);
   }, [_children, name, value, isInvalid, change]);
+  var isSupportingHidden = supporting$1 === false || supporting$1 === null;
   return /*#__PURE__*/React.createElement(layout.default, {
     label: props.label,
     required: required,
     className: classNames.item,
-    supporting: /*#__PURE__*/React.createElement(React.Fragment, null, !!supporting$1 && /*#__PURE__*/React.createElement(supporting.default, null, supporting$1), /*#__PURE__*/React.createElement(react.AnimatePresence, {
+    supporting: !isSupportingHidden && (/*#__PURE__*/React.createElement(React.Fragment, null, !!supporting$1 && /*#__PURE__*/React.createElement(supporting.default, null, supporting$1), /*#__PURE__*/React.createElement(react.AnimatePresence, {
       mode: "wait"
-    }, isInvalid && (renderError === false ? null : relax.isFunction(renderError) ? renderError(error$1) : (/*#__PURE__*/React.createElement(error.default, null, error$1)))))
+    }, isInvalid && /*#__PURE__*/React.createElement(error.default, null, error$1))))
   }, /*#__PURE__*/React.createElement("div", {
     className: className.stringify(classNames.field, className$1),
     style: style

package/dist/components/form/field/field.d.ts

@@ -6,5 +6,5 @@ import type { RequiredIn } from "@aiszlab/relax/types";
  * form item may not has name prop
  * if there is name prop, it will render
  */
-declare const Field: <T extends FieldsValue, FieldKey extends keyof T>({ required, children: _children, className, style, supporting, error: renderError, name, rules, ...props }: RequiredIn<FormItemProps<T, FieldKey>, "name" | "required">) => React.JSX.Element;
+declare const Field: <T extends FieldsValue, FieldKey extends keyof T>({ required, children: _children, className, style, supporting, name, rules, ...props }: RequiredIn<FormItemProps<T, FieldKey>, "name" | "required">) => React.JSX.Element;
 export default Field;

package/dist/components/form/field/field.mjs

@@ -1,7 +1,7 @@
 import _slicedToArray from '@babel/runtime/helpers/slicedToArray';
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
 import React, { useContext, useMemo, Children, isValidElement, cloneElement } from 'react';
-import { chain, isFunction } from '@aiszlab/relax';
+import { chain } from '@aiszlab/relax';
 import Layout from './layout.mjs';
 import Error from './error.mjs';
 import { AnimatePresence } from 'motion/react';
@@ -10,7 +10,7 @@ import { stringify } from '@aiszlab/relax/class-name';
 import Context from '../context.mjs';
 import { useFormItem } from '../hooks/index.mjs';
 
-var _excluded = ["required", "children", "className", "style", "supporting", "error", "name", "rules"];
+var _excluded = ["required", "children", "className", "style", "supporting", "name", "rules"];
 /**
  * @description
  * form item may not has name prop
@@ -22,7 +22,6 @@ var Field = function Field(_ref) {
     className = _ref.className,
     style = _ref.style,
     supporting = _ref.supporting,
-    renderError = _ref.error,
     name = _ref.name,
     rules = _ref.rules,
     props = _objectWithoutProperties(_ref, _excluded);
@@ -53,13 +52,14 @@ var Field = function Field(_ref) {
       })), true];
     }, [[], false]).at(0);
   }, [_children, name, value, isInvalid, change]);
+  var isSupportingHidden = supporting === false || supporting === null;
   return /*#__PURE__*/React.createElement(Layout, {
     label: props.label,
     required: required,
     className: classNames.item,
-    supporting: /*#__PURE__*/React.createElement(React.Fragment, null, !!supporting && /*#__PURE__*/React.createElement(Supporting, null, supporting), /*#__PURE__*/React.createElement(AnimatePresence, {
+    supporting: !isSupportingHidden && (/*#__PURE__*/React.createElement(React.Fragment, null, !!supporting && /*#__PURE__*/React.createElement(Supporting, null, supporting), /*#__PURE__*/React.createElement(AnimatePresence, {
       mode: "wait"
-    }, isInvalid && (renderError === false ? null : isFunction(renderError) ? renderError(error) : (/*#__PURE__*/React.createElement(Error, null, error)))))
+    }, isInvalid && /*#__PURE__*/React.createElement(Error, null, error))))
   }, /*#__PURE__*/React.createElement("div", {
     className: stringify(classNames.field, className),
     style: style

package/dist/types/form.d.ts

@@ -3,66 +3,80 @@ import type { FieldsValue, Form, Rule, FORM_TOKEN, ChangeHandler } from "../util
 import type { Nullable, Partialable } from "@aiszlab/relax/types";
 import type { ComponentProps } from "./element";
 /**
- * form hook return
+ * @zh 表单实例 hook 的返回值。
+ * @en Return value of the form instance hook.
  */
 interface UsedForm<T extends FieldsValue> {
     /**
-     * set field value
+     * @zh 设置指定字段的值，并清除该字段的校验错误。
+     * @en Set a field value and clear that field's validation error.
      */
     setFieldValue(name: keyof T, value: T[keyof T]): void;
     /**
-     * set fields value
-     * @description set multiple fields value
+     * @zh 批量设置字段值，并清除这些字段的校验错误。
+     * @en Set multiple field values and clear their validation errors.
      */
     setFieldsValue(value: Partial<T>): void;
     /**
-     * reset fields value and clear errors
+     * @zh 将字段值重置为 `defaultValue`，并清除所有校验错误。
+     * @en Reset field values to `defaultValue` and clear all validation errors.
      */
     reset(): void;
     /**
-     * clear fields value and clear errors
+     * @zh 清空字段值并清除所有校验错误。
+     * @en Clear field values and all validation errors.
      */
     clear(): void;
     /**
-     * validate
+     * @zh 校验所有已注册字段；全部通过时返回 `true`。
+     * @en Validate all registered fields; resolve to `true` when all pass.
      */
     validate: () => Promise<boolean>;
     /**
-     * get field value
+     * @zh 获取指定字段当前值。
+     * @en Get the current value of a field.
      */
     getFieldValue: <FieldValue = T[keyof T]>(name: keyof T) => Partialable<FieldValue>;
     /**
-     * get fields value
+     * @zh 获取已注册字段的当前值。
+     * @en Get the current values of registered fields.
      */
     getFieldsValue: () => Partial<T>;
     /**
-     * form instance
+     * @zh 底层表单实例，供组件内部共享使用。
+     * @en Underlying form instance shared by the form components.
      */
     [FORM_TOKEN]: Form<T>;
 }
 /**
- * form hook props
+ * @zh 表单实例 hook 的配置参数。
+ * @en Configuration options for the form instance hook.
  */
 interface UsingForm<T extends FieldsValue> {
     /**
-     * form default value
+     * @zh 非受控表单的初始值，也作为调用 `reset()` 时恢复的值。
+     * @en Initial value for an uncontrolled form and the value restored by `reset()`.
      */
     defaultValue?: Partial<T>;
     /**
-     * registered form
+     * @zh 复用已有的表单实例；不传时会创建新实例。
+     * @en Reuse an existing form instance; a new instance is created when omitted.
      */
     form?: UsedForm<T>;
     /**
-     * change handler
+     * @zh 字段通过表单交互发生变化时调用，参数依次为已登记字段值和本次变更的字段名。
+     * @en Called when a field changes through form interaction, with registered field values and the names changed.
      */
     onChange?: ChangeHandler<T>;
     /**
-     * controlled form value
+     * @zh 受控表单的当前值；传入后由调用方负责更新该值。
+     * @en Current value of a controlled form; the caller is responsible for updating it.
      */
     value?: Partial<T>;
 }
 /**
- * form props
+ * @zh Form 组件的参数。
+ * @en Props for the Form component.
  */
 interface FormProps<T extends FieldsValue> extends ComponentProps {
     /**
@@ -72,26 +86,28 @@ interface FormProps<T extends FieldsValue> extends ComponentProps {
      */
     layout?: FormLayout;
     /**
-     * used form instance
-     * use `form` can control `Form` value
+     * @zh 传入 `Form.useForm()` 创建的实例以复用或外部操作表单。
+     * @en Pass an instance from `Form.useForm()` to reuse or control the form externally.
      */
     form?: UsedForm<T>;
     /**
-     * children components
+     * @zh 表单内容，通常包含 `Form.Item` 等表单项。
+     * @en Form contents, usually including fields such as `Form.Item`.
      */
     children: ReactNode;
     /**
-     * form value change handler
+     * @zh 字段通过表单交互发生变化时调用，参数依次为已登记字段值和本次变更的字段名。
+     * @en Called when a field changes through form interaction, with registered field values and the names changed.
      */
     onChange?: ChangeHandler<T>;
     /**
-     * default value
+     * @zh 非受控表单的初始值，也作为调用 `form.reset()` 时恢复的值。
+     * @en Initial value for an uncontrolled form and the value restored by `form.reset()`.
      */
     defaultValue?: Partial<T>;
     /**
-     * controlled value
-     * @description
-     * if `value` is provided, `Form` will be controlled
+     * @zh 受控表单的当前值；传入后由调用方负责更新该值。
+     * @en Current value of a controlled form; the caller is responsible for updating it.
      */
     value?: Partial<T>;
 }
@@ -141,52 +157,58 @@ interface TypedForm {
     useFormContext: UseFormContext;
 }
 /**
- * form item props
+ * @zh Form.Item 组件的参数。
+ * @en Props for the Form.Item component.
  */
 interface FormItemProps<T extends FieldsValue, FieldKey extends keyof T> {
     /**
-     * name
+     * @zh 对应表单数据中的字段名；省略时该项不与表单值绑定。
+     * @en Field name in the form data; when omitted, this item is not bound to a form value.
      */
     name?: FieldKey;
     /**
-     * required field
+     * @zh 标记该字段为必填，并用于显示必填状态。
+     * @en Mark the field as required and display its required state.
      */
     required?: boolean;
     /**
-     * class name
+     * @zh 应用于表单项根元素的额外类名。
+     * @en Additional class name applied to the form item root.
      */
     className?: string;
     /**
-     * style
+     * @zh 应用于表单项根元素的内联样式。
+     * @en Inline styles applied to the form item root.
      */
     style?: CSSProperties;
     /**
-     * supporting
+     * @zh 显示在字段下方的补充说明。
+     * @en Supporting text displayed below the field.
      */
     supporting?: ReactNode;
     /**
-     * @zh 自定义错误消息的渲染方式
-     * @en Customize how the error message is rendered
-     */
-    error?: false | ((error: ReactNode) => ReactNode);
-    /**
-     * label
+     * @zh 字段标签内容。
+     * @en Field label content.
      */
     label?: ReactNode;
     /**
-     * labelCol
+     * @zh 标签区域占用的栅格列数。
+     * @en Number of grid columns occupied by the label.
      */
     labelCol?: number;
     /**
-     * wrapperCol
+     * @zh 字段控件区域占用的栅格列数。
+     * @en Number of grid columns occupied by the field control.
      */
     wrapperCol?: number;
     /**
-     * children
+     * @zh 字段控件或其他表单项内容。
+     * @en Field control or other form item content.
      */
     children?: ReactNode;
     /**
-     * rules
+     * @zh 按顺序执行的字段校验规则。
+     * @en Validation rules run for this field.
      */
     rules?: Rule<T, FieldKey>[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musae",
-  "version": "1.3.1-beta.19",
+  "version": "1.3.1-beta.20",
   "description": "musae-ui",
   "author": "tutu@fantufantu.com",
   "license": "MIT",