@next-bricks/form 1.21.10 → 1.21.12

package/dist/manifest.json

@@ -93,7 +93,7 @@
           "name": "change",
           "description": "",
           "detail": {
-            "description": null,
+            "description": "当前输入值",
             "type": "string"
           }
         }
@@ -103,7 +103,7 @@
         {
           "name": "focusTextarea",
           "params": [],
-          "description": "focus",
+          "description": "使文本域获得焦点",
           "returns": {}
         }
       ],
@@ -119,6 +119,7 @@
       "properties": [
         {
           "name": "staticValues",
+          "description": "静态附加值，在表单验证成功时会合并到 validate.success 事件的 detail 中",
           "attribute": false,
           "type": "Record<string, unknown>"
         },
@@ -149,10 +150,12 @@
         },
         {
           "name": "autoScrollToInvalidFields",
+          "description": "是否在验证失败时自动滚动到第一个错误字段",
           "type": "boolean"
         },
         {
           "name": "formStyle",
+          "description": "表单自定义样式",
           "attribute": false,
           "type": "React.CSSProperties"
         },
@@ -167,7 +170,7 @@
           "name": "values.change",
           "description": "表单值变更事件",
           "detail": {
-            "description": null,
+            "description": "当前所有表单字段的值",
             "type": "Record<string, unknown>"
           }
         },
@@ -175,6 +178,7 @@
           "name": "validate.success",
           "description": "表单验证成功时触发事件",
           "detail": {
+            "description": "表单所有字段的值，包含合并后的 staticValues",
             "type": "Record<string, unknown>"
           }
         },
@@ -182,6 +186,7 @@
           "name": "validate.error",
           "description": "表单验证报错时触发事件",
           "detail": {
+            "description": "校验失败的字段信息列表，每项包含 name（字段名）及错误消息",
             "type": "(MessageBody & { name: string })[]"
           }
         }
@@ -206,54 +211,70 @@
           "params": [
             {
               "name": "values",
+              "description": "要设置的表单字段值",
               "type": "Record<string, unknown>"
             },
             {
               "name": "options",
+              "description": "可选配置，支持 runInMicrotask（微任务中执行）和 runInMacrotask（宏任务中执行）",
               "type": "{ runInMacrotask?: boolean; runInMicrotask?: boolean }"
             }
           ],
           "description": "表单设置值方法",
-          "returns": {}
+          "returns": {
+            "type": "void"
+          }
         },
         {
           "name": "resetFields",
           "params": [
             {
               "name": "name",
+              "description": "要重置的字段名，不传则重置所有字段",
               "type": "string"
             }
           ],
           "description": "表单重置值方法",
-          "returns": {}
+          "returns": {
+            "type": "void"
+          }
         },
         {
           "name": "getFieldsValue",
           "params": [
             {
               "name": "name",
+              "description": "要获取的字段名，不传则获取所有字段的值",
               "type": "string"
             }
           ],
           "description": "获取表单值方法",
-          "returns": {}
+          "returns": {
+            "description": "指定字段的值，或所有字段值的对象",
+            "type": "Record<string, unknown> | unknown"
+          }
         },
         {
           "name": "validateField",
           "params": [
             {
               "name": "name",
+              "description": "要校验的字段名",
               "type": "string"
             }
           ],
           "description": "校验表单字段方法",
-          "returns": {}
+          "returns": {
+            "type": "void"
+          }
         },
         {
           "name": "resetValidateState",
           "params": [],
           "description": "重置表单校验状态方法",
-          "returns": {}
+          "returns": {
+            "type": "void"
+          }
         }
       ],
       "parts": [],
@@ -268,7 +289,7 @@
       "properties": [
         {
           "name": "name",
-          "description": "下拉框字段名",
+          "description": "字段名称",
           "type": "string"
         },
         {
@@ -285,7 +306,7 @@
         },
         {
           "name": "value",
-          "description": "单选框当前选中始值",
+          "description": "单选框当前选中值",
           "attribute": false,
           "type": "any"
         },
@@ -346,6 +367,7 @@
           "name": "change",
           "description": "值变化事件",
           "detail": {
+            "description": "`GeneralComplexOption | undefined` — 当前选中项的完整选项对象",
             "type": "GeneralComplexOption | undefined"
           }
         },
@@ -353,6 +375,7 @@
           "name": "options.change",
           "description": "选项列表变化事件",
           "detail": {
+            "description": "`{ options: { label: string; value: any; [key: string]: any }; name: string }` — 最新的选项列表及字段名",
             "type": "{\n    options: {\n      label: string;\n      value: any;\n      [key: string]: any;\n    };\n    name: string;\n  }"
           }
         }
@@ -436,7 +459,7 @@
         },
         {
           "name": "suffix",
-          "description": "",
+          "description": "后缀内容，使用 useBrick 在选项及选中值旁显示额外信息",
           "attribute": false,
           "type": "{ useBrick: UseSingleBrickConf }"
         },
@@ -491,6 +514,7 @@
           "name": "change",
           "description": "下拉选择事件",
           "detail": {
+            "description": "`{ value: string | string[]; options: GeneralComplexOption[] }` — 选中的值及对应选项列表",
             "type": "ChangeEventDetail"
           }
         },
@@ -506,6 +530,7 @@
           "name": "search",
           "description": "下拉框search事件",
           "detail": {
+            "description": "`{ value: string }` — 当前输入的搜索词",
             "type": "SearchEventDetail"
           }
         },
@@ -520,6 +545,7 @@
           "name": "options.change",
           "description": "选项列表变化事件",
           "detail": {
+            "description": "`{ options: { label: string; value: any; [key: string]: any }; name: string }` — 最新的选项列表及字段名",
             "type": "OptionsChangeEventDetail"
           }
         }
@@ -638,7 +664,7 @@
         },
         {
           "name": "isCustom",
-          "description": "是否为自定义",
+          "description": "是否为自定义样式，仅在 type=\"icon\" 时生效，启用后图标尺寸更大（52px）",
           "default": "false",
           "type": "boolean"
         },
@@ -655,7 +681,7 @@
         },
         {
           "name": "isGroup",
-          "description": "是否为复选框，为true时，则可设置分组数据 optionGroups",
+          "description": "是否启用分组模式，为 true 时，则可设置分组数据 optionGroups",
           "type": "boolean"
         },
         {
@@ -673,15 +699,17 @@
       "events": [
         {
           "name": "change",
-          "description": "复选框变化事件",
+          "description": "复选框选中项发生变化时触发",
           "detail": {
+            "description": "{ value: 选中项的值, label: 选中项的标签, disabled: 是否禁用, checkboxColor: 复选框颜色 }[]",
             "type": "CheckboxOptionType[]"
           }
         },
         {
           "name": "options.change",
-          "description": "复选框变化事件",
+          "description": "复选框选项数据变化时触发",
           "detail": {
+            "description": "{ options: 最新的选项列表, name: 字段名称 }",
             "type": "OptionsChangeEventDetail"
           }
         }
@@ -759,21 +787,25 @@
       "events": [
         {
           "name": "change",
+          "description": "表单值改变时触发",
           "detail": {
+            "description": "整个动态表单当前所有行的值列表",
             "type": "DynamicFormValuesItem[]"
           }
         },
         {
           "name": "row.add",
-          "description": "增加一行时触发，detail为该行的默认值，index为该行的位置",
+          "description": "增加一行时触发",
           "detail": {
+            "description": "{ detail: 该行的默认值, index: 该行的位置 }",
             "type": "rowDataType"
           }
         },
         {
           "name": "row.remove",
-          "description": "移除一行时触发，detail为该行的值，index为该行的位置",
+          "description": "移除一行时触发",
           "detail": {
+            "description": "{ detail: 该行的值, index: 该行的位置 }",
             "type": "rowDataType"
           }
         }
@@ -837,15 +869,17 @@
       "events": [
         {
           "name": "change",
-          "description": "输入的搜索字符，输入变化时触发",
+          "description": "",
           "detail": {
+            "description": "当前输入值",
             "type": "string"
           }
         },
         {
           "name": "search",
-          "description": "搜索时触发",
+          "description": "",
           "detail": {
+            "description": "搜索关键词",
             "type": "string"
           }
         }
@@ -890,7 +924,7 @@
         },
         {
           "name": "message",
-          "description": "是否必填",
+          "description": "校验错误提示信息",
           "attribute": false,
           "type": "Record<string, string>"
         },
@@ -905,6 +939,7 @@
           "name": "change",
           "description": "值变化时触发",
           "detail": {
+            "description": "`Icon | undefined` — { lib: 图标库, icon: 图标名称, category: 图标分类, color: 图标颜色 } | undefined",
             "type": "Icon | undefined"
           }
         }
@@ -982,8 +1017,9 @@
       "events": [
         {
           "name": "change",
-          "description": "值变化时触发",
+          "description": "",
           "detail": {
+            "description": "{ uid: 文件唯一标识, name: 文件名, url: 图片地址, file: 原始 File 对象, response: 上传响应内容, status: 上传状态（uploading | done | error）, errors: 错误信息列表 }[]",
             "type": "ImageData[]"
           }
         }
@@ -1043,7 +1079,7 @@
         },
         {
           "name": "unCheckedIcon",
-          "description": "非选中时的文本",
+          "description": "非选中时的图标",
           "attribute": false,
           "type": "GeneralIconProps"
         },
@@ -1058,6 +1094,7 @@
           "name": "switch",
           "description": "开关改变时触发",
           "detail": {
+            "description": "`boolean` — 开关当前状态，true 表示开启，false 表示关闭",
             "type": "boolean"
           }
         }
@@ -1131,7 +1168,7 @@
         },
         {
           "name": "buttonIcon",
-          "description": "上传按钮类型",
+          "description": "上传按钮图标",
           "default": "{\n    lib: \"antd\",\n    icon: \"upload\",\n    theme: \"outlined\",\n  }",
           "attribute": false,
           "type": "GeneralIconProps"
@@ -1184,8 +1221,9 @@
       "events": [
         {
           "name": "change",
-          "description": "值变化时触发",
+          "description": "",
           "detail": {
+            "description": "{ uid: 文件唯一标识, name: 文件名, file: 原始 File 对象, response: 上传响应内容, status: 上传状态（uploading | done | error）, errors: 错误信息列表 }[]",
             "type": "FileData[]"
           }
         }
@@ -1232,6 +1270,7 @@
         },
         {
           "name": "value",
+          "description": "输入框当前值",
           "type": "string"
         },
         {
@@ -1267,13 +1306,19 @@
       "events": [
         {
           "name": "change",
-          "description": "值改变事件",
+          "description": "",
           "detail": {
+            "description": "当前输入框的值",
             "type": "string"
           }
         }
       ],
-      "slots": [],
+      "slots": [
+        {
+          "name": "options-toolbar",
+          "description": "下拉列表底部工具栏"
+        }
+      ],
       "methods": [],
       "parts": [],
       "description": "带候选项的输入框",
@@ -1328,22 +1373,25 @@
       "events": [
         {
           "name": "change",
-          "description": "时间变化时触发",
+          "description": "",
           "detail": {
+            "description": "格式化后的时间字符串",
             "type": "string"
           }
         },
         {
           "name": "open",
-          "description": "面板打开时触发， 传出当前时间值",
+          "description": "",
           "detail": {
+            "description": "面板打开时的当前时间值字符串",
             "type": "string"
           }
         },
         {
           "name": "close",
-          "description": "面板关闭时触发，传出当前时间值",
+          "description": "",
           "detail": {
+            "description": "面板关闭时的当前时间值字符串",
             "type": "string"
           }
         }
@@ -1435,15 +1483,17 @@
       "events": [
         {
           "name": "change",
-          "description": "日期变化时触发",
+          "description": "",
           "detail": {
+            "description": "格式化后的日期字符串",
             "type": "string"
           }
         },
         {
           "name": "ok",
-          "description": "点击确定按钮触发（showTime 为 true 使用）",
+          "description": "",
           "detail": {
+            "description": "格式化后的日期字符串",
             "type": "string"
           }
         }
@@ -1504,19 +1554,20 @@
         },
         {
           "name": "emitChangeOnInit",
-          "description": "",
-          "default": "true\n是否在初始化完成后额外触发一次`time.range.change`, 这里因为历史原因之前默认行为就是在初始化后会触发该事件，这里为了兼容之前的行为，默认值只能设置为 true。",
+          "description": "是否在初始化完成后额外触发一次 change 事件。因历史原因，默认行为就是在初始化后触发该事件，为了兼容之前的行为，默认值只能设置为 true。",
+          "default": "true",
           "type": "boolean"
         },
         {
           "name": "presetRanges",
-          "description": "",
-          "default": "[]\n预设时间范围快捷选择；设置了属性selectNearDays时，属性presetRanges不生效；属性rangeType为week时，presetRanges的值只能为本周、本月、本季度、今年，属性rangeType为month、quarter、year时，以此类推",
+          "description": "预设时间范围快捷选择。设置了 selectNearDays 时，presetRanges 不生效；rangeType 为 week 时只能选本周、本月、本季度、今年，rangeType 为 month、quarter、year 时以此类推。",
+          "default": "[]",
           "attribute": false,
           "type": "presetRangeType[]"
         },
         {
           "name": "validator",
+          "description": "自定义校验函数，返回错误信息字符串或 MessageBody 对象，返回空字符串表示校验通过。",
           "attribute": false,
           "type": "((value: any) => MessageBody | string)"
         }
@@ -1524,8 +1575,9 @@
       "events": [
         {
           "name": "change",
-          "description": "时间段变化时触发",
+          "description": "",
           "detail": {
+            "description": "{ startTime: 开始时间字符串, endTime: 结束时间字符串 }",
             "type": "TimeRange"
           }
         }
@@ -1605,6 +1657,7 @@
           "name": "change",
           "description": "颜色变化事件, 返回值格式和`format`格式一致",
           "detail": {
+            "description": "选中的颜色值，格式由 format 属性决定（hex/rgb/hsb），清除时为 undefined",
             "type": "string | undefined"
           }
         }
@@ -1612,7 +1665,8 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件 `eo-color-picker`"
+      "description": "颜色选择器",
+      "category": "form-input-basic"
     },
     {
       "name": "eo-form-item",
@@ -1637,27 +1691,33 @@
         },
         {
           "name": "label",
+          "description": "标签文字",
           "type": "string"
         },
         {
           "name": "pattern",
+          "description": "正则校验规则",
           "type": "string"
         },
         {
           "name": "message",
+          "description": "校验失败时的提示信息",
           "attribute": false,
           "type": "Record<string, string>"
         },
         {
           "name": "type",
+          "description": "校验类型",
           "type": "string"
         },
         {
           "name": "max",
+          "description": "表单校验最大值（当 type 为 number 时表示最大数值，否则表示最大长度）",
           "type": "number"
         },
         {
           "name": "min",
+          "description": "表单校验最小值（当 type 为 number 时表示最小数值，否则表示最小长度）",
           "type": "number"
         },
         {
@@ -1672,14 +1732,18 @@
         },
         {
           "name": "valuePropsName",
+          "description": "子构件中对应值的属性名",
+          "default": "\"value\"",
           "type": "string"
         },
         {
           "name": "layout",
+          "description": "布局方式",
           "type": "Layout"
         },
         {
           "name": "size",
+          "description": "尺寸",
           "type": "ComponentSize"
         },
         {
@@ -1690,6 +1754,7 @@
         {
           "name": "trigger",
           "description": "事件触发方法名",
+          "default": "\"onChange\"",
           "type": "string"
         },
         {
@@ -1700,7 +1765,7 @@
         },
         {
           "name": "needValidate",
-          "description": "值变化时是否主动出发校验",
+          "description": "值变化时是否主动触发校验",
           "type": "boolean"
         },
         {
@@ -1718,7 +1783,7 @@
       ],
       "methods": [],
       "parts": [],
-      "description": "通用输入框构件",
+      "description": "表单项构件",
       "category": "form-input-basic",
       "insider": true
     },
@@ -1837,8 +1902,9 @@
       "events": [
         {
           "name": "change",
-          "description": "值改变事件",
+          "description": "",
           "detail": {
+            "description": "当前输入值",
             "type": "string"
           }
         }
@@ -1865,13 +1931,13 @@
         {
           "name": "focusInput",
           "params": [],
-          "description": "focus",
+          "description": "使输入框获得焦点",
           "returns": {}
         },
         {
           "name": "blurInput",
           "params": [],
-          "description": "blur",
+          "description": "使输入框失去焦点",
           "returns": {}
         }
       ],

package/dist/types.json

@@ -1788,7 +1788,12 @@
             }
           }
         ],
-        "returns": {}
+        "returns": {
+          "annotation": {
+            "type": "keyword",
+            "value": "void"
+          }
+        }
       },
       {
         "name": "resetFields",
@@ -1801,7 +1806,12 @@
             }
           }
         ],
-        "returns": {}
+        "returns": {
+          "annotation": {
+            "type": "keyword",
+            "value": "void"
+          }
+        }
       },
       {
         "name": "getFieldsValue",
@@ -1814,7 +1824,37 @@
             }
           }
         ],
-        "returns": {}
+        "returns": {
+          "annotation": {
+            "type": "union",
+            "types": [
+              {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "Record"
+                },
+                "typeParameters": {
+                  "type": "typeParameterInstantiation",
+                  "params": [
+                    {
+                      "type": "keyword",
+                      "value": "string"
+                    },
+                    {
+                      "type": "keyword",
+                      "value": "unknown"
+                    }
+                  ]
+                }
+              },
+              {
+                "type": "keyword",
+                "value": "unknown"
+              }
+            ]
+          }
+        }
       },
       {
         "name": "validateField",
@@ -1827,12 +1867,22 @@
             }
           }
         ],
-        "returns": {}
+        "returns": {
+          "annotation": {
+            "type": "keyword",
+            "value": "void"
+          }
+        }
       },
       {
         "name": "resetValidateState",
         "params": [],
-        "returns": {}
+        "returns": {
+          "annotation": {
+            "type": "keyword",
+            "value": "void"
+          }
+        }
       }
     ],
     "types": [

package/dist-types/auto-complete/index.d.ts

@@ -34,6 +34,7 @@ export type OptionType = Option | OptionGroup;
  * @author zhendonghuang
  *
  * @category form-input-basic
+ * @slot options-toolbar - 下拉列表底部工具栏
  */
 export declare class AutoComplete extends FormItemElementBase {
     #private;
@@ -61,6 +62,9 @@ export declare class AutoComplete extends FormItemElementBase {
      * 是否必填
      */
     accessor required: boolean | undefined;
+    /**
+     * 输入框当前值
+     */
     accessor value: string | undefined;
     /**
      * 选项列表