@next-bricks/form 1.13.10 → 1.13.11

package/dist/manifest.json

@@ -287,144 +287,107 @@
       "category": "form-input-basic"
     },
     {
-      "name": "eo-form",
+      "name": "eo-form-item",
       "alias": [
-        "form.general-form"
+        "form.general-form-item"
       ],
       "properties": [
         {
-          "name": "staticValues",
+          "name": "formElement",
           "attribute": false,
-          "type": "Record<string, unknown>"
+          "type": "Form"
         },
         {
-          "name": "layout",
-          "description": "布局方式(默认 vertical 布局)",
-          "default": "vertical",
-          "type": "Layout"
+          "name": "curElement",
+          "attribute": false,
+          "type": "HTMLElement"
         },
         {
-          "name": "size",
-          "description": "表单组件尺寸",
-          "type": "ComponentSize"
+          "name": "name",
+          "description": "字段名称",
+          "type": "string"
         },
         {
-          "name": "labelCol",
-          "description": "标签列布局样式（仅当 layout=\"horizontal\" 时有效）",
-          "default": "{\n    sm: {\n      span: 24,\n    },\n    md: {\n      span: 24,\n    },\n    lg: {\n      span: 7,\n    },\n    xl: {\n      span: 5,\n    },\n    xxl: {\n      span: 4,\n    },\n  }",
-          "attribute": false,
-          "type": "ColProps"
+          "name": "label",
+          "type": "string"
         },
         {
-          "name": "wrapperCol",
-          "description": "输入控件列布局样式（仅当 layout=\"horizontal\" 时有效）",
-          "default": "{\n    sm: {\n      span: 18,\n    },\n    md: {\n      span: 18,\n    },\n    lg: {\n      span: 13,\n    },\n    xl: {\n      span: 16,\n    },\n    xxl: {\n      span: 18,\n    },\n  }",
-          "attribute": false,
-          "type": "ColProps"
+          "name": "pattern",
+          "type": "string"
         },
         {
-          "name": "formStyle",
+          "name": "message",
           "attribute": false,
-          "type": "React.CSSProperties"
-        }
-      ],
-      "events": [
+          "type": "Record<string, string>"
+        },
         {
-          "name": "values.change",
-          "description": "表单值变更事件",
-          "detail": {
-            "description": null,
-            "type": "Record<string, unknown>"
-          }
+          "name": "type",
+          "type": "string"
         },
         {
-          "name": "validate.success",
-          "description": "表单验证成功时触发事件",
-          "detail": {
-            "type": "Record<string, unknown>"
-          }
+          "name": "max",
+          "type": "number"
         },
         {
-          "name": "validate.error",
-          "description": "表单验证报错时触发事件",
-          "detail": {
-            "type": "(MessageBody & { name: string })[]"
-          }
-        }
-      ],
-      "slots": [
+          "name": "min",
+          "type": "number"
+        },
         {
-          "name": null,
-          "description": "表单内容"
-        }
-      ],
-      "methods": [
+          "name": "required",
+          "description": "表单项是否为必填",
+          "type": "boolean"
+        },
         {
-          "name": "validate",
-          "params": [],
-          "description": "表单校验方法",
-          "returns": {
-            "type": "boolean | Record<string, unknown>"
-          }
+          "name": "value",
+          "description": "初始值",
+          "type": "string"
         },
         {
-          "name": "setInitValue",
-          "params": [
-            {
-              "name": "values",
-              "type": "Record<string, unknown>"
-            },
-            {
-              "name": "options",
-              "type": "{ runInMacrotask?: boolean; runInMicrotask?: boolean }"
-            }
-          ],
-          "description": "表单设置值方法",
-          "returns": {}
+          "name": "valuePropsName",
+          "type": "string"
         },
         {
-          "name": "resetFields",
-          "params": [
-            {
-              "name": "name",
-              "type": "string"
-            }
-          ],
-          "description": "表单重置值方法",
-          "returns": {}
+          "name": "layout",
+          "type": "Layout"
         },
         {
-          "name": "getFieldsValue",
-          "params": [
-            {
-              "name": "name",
-              "type": "string"
-            }
-          ],
-          "description": "获取表单值方法",
-          "returns": {}
+          "name": "size",
+          "type": "ComponentSize"
         },
         {
-          "name": "validateField",
-          "params": [
-            {
-              "name": "name",
-              "type": "string"
-            }
-          ],
-          "description": "校验表单字段方法",
-          "returns": {}
+          "name": "trim",
+          "description": "是否自动去除前后的空白字符",
+          "default": "true"
         },
         {
-          "name": "resetValidateState",
-          "params": [],
-          "description": "重置表单校验状态方法",
-          "returns": {}
+          "name": "trigger",
+          "description": "事件触发方法名",
+          "type": "string"
+        },
+        {
+          "name": "validator",
+          "description": "表单项校验方法",
+          "attribute": false,
+          "type": "((value: any) => MessageBody)"
+        },
+        {
+          "name": "needValidate",
+          "description": "值变化时是否主动出发校验",
+          "type": "boolean"
         }
       ],
+      "events": [],
+      "slots": [
+        {
+          "name": null,
+          "description": "表单项内容"
+        }
+      ],
+      "methods": [],
       "parts": [],
-      "description": "表单构件",
-      "category": "form-input-basic"
+      "description": "通用输入框构件",
+      "category": "form-input-basic",
+      "insider": true
     },
     {
       "name": "eo-radio",
@@ -525,107 +488,144 @@
       "category": "form-input-basic"
     },
     {
-      "name": "eo-form-item",
+      "name": "eo-form",
       "alias": [
-        "form.general-form-item"
+        "form.general-form"
       ],
       "properties": [
         {
-          "name": "formElement",
-          "attribute": false,
-          "type": "Form"
-        },
-        {
-          "name": "curElement",
+          "name": "staticValues",
           "attribute": false,
-          "type": "HTMLElement"
-        },
-        {
-          "name": "name",
-          "description": "字段名称",
-          "type": "string"
+          "type": "Record<string, unknown>"
         },
         {
-          "name": "label",
-          "type": "string"
+          "name": "layout",
+          "description": "布局方式(默认 vertical 布局)",
+          "default": "vertical",
+          "type": "Layout"
         },
         {
-          "name": "pattern",
-          "type": "string"
+          "name": "size",
+          "description": "表单组件尺寸",
+          "type": "ComponentSize"
         },
         {
-          "name": "message",
+          "name": "labelCol",
+          "description": "标签列布局样式（仅当 layout=\"horizontal\" 时有效）",
+          "default": "{\n    sm: {\n      span: 24,\n    },\n    md: {\n      span: 24,\n    },\n    lg: {\n      span: 7,\n    },\n    xl: {\n      span: 5,\n    },\n    xxl: {\n      span: 4,\n    },\n  }",
           "attribute": false,
-          "type": "Record<string, string>"
+          "type": "ColProps"
         },
         {
-          "name": "type",
-          "type": "string"
+          "name": "wrapperCol",
+          "description": "输入控件列布局样式（仅当 layout=\"horizontal\" 时有效）",
+          "default": "{\n    sm: {\n      span: 18,\n    },\n    md: {\n      span: 18,\n    },\n    lg: {\n      span: 13,\n    },\n    xl: {\n      span: 16,\n    },\n    xxl: {\n      span: 18,\n    },\n  }",
+          "attribute": false,
+          "type": "ColProps"
         },
         {
-          "name": "max",
-          "type": "number"
-        },
+          "name": "formStyle",
+          "attribute": false,
+          "type": "React.CSSProperties"
+        }
+      ],
+      "events": [
         {
-          "name": "min",
-          "type": "number"
+          "name": "values.change",
+          "description": "表单值变更事件",
+          "detail": {
+            "description": null,
+            "type": "Record<string, unknown>"
+          }
         },
         {
-          "name": "required",
-          "description": "表单项是否为必填",
-          "type": "boolean"
+          "name": "validate.success",
+          "description": "表单验证成功时触发事件",
+          "detail": {
+            "type": "Record<string, unknown>"
+          }
         },
         {
-          "name": "value",
-          "description": "初始值",
-          "type": "string"
-        },
+          "name": "validate.error",
+          "description": "表单验证报错时触发事件",
+          "detail": {
+            "type": "(MessageBody & { name: string })[]"
+          }
+        }
+      ],
+      "slots": [
         {
-          "name": "valuePropsName",
-          "type": "string"
-        },
+          "name": null,
+          "description": "表单内容"
+        }
+      ],
+      "methods": [
         {
-          "name": "layout",
-          "type": "Layout"
+          "name": "validate",
+          "params": [],
+          "description": "表单校验方法",
+          "returns": {
+            "type": "boolean | Record<string, unknown>"
+          }
         },
         {
-          "name": "size",
-          "type": "ComponentSize"
+          "name": "setInitValue",
+          "params": [
+            {
+              "name": "values",
+              "type": "Record<string, unknown>"
+            },
+            {
+              "name": "options",
+              "type": "{ runInMacrotask?: boolean; runInMicrotask?: boolean }"
+            }
+          ],
+          "description": "表单设置值方法",
+          "returns": {}
         },
         {
-          "name": "trim",
-          "description": "是否自动去除前后的空白字符",
-          "default": "true"
+          "name": "resetFields",
+          "params": [
+            {
+              "name": "name",
+              "type": "string"
+            }
+          ],
+          "description": "表单重置值方法",
+          "returns": {}
         },
         {
-          "name": "trigger",
-          "description": "事件触发方法名",
-          "type": "string"
+          "name": "getFieldsValue",
+          "params": [
+            {
+              "name": "name",
+              "type": "string"
+            }
+          ],
+          "description": "获取表单值方法",
+          "returns": {}
         },
         {
-          "name": "validator",
-          "description": "表单项校验方法",
-          "attribute": false,
-          "type": "((value: any) => MessageBody)"
+          "name": "validateField",
+          "params": [
+            {
+              "name": "name",
+              "type": "string"
+            }
+          ],
+          "description": "校验表单字段方法",
+          "returns": {}
         },
         {
-          "name": "needValidate",
-          "description": "值变化时是否主动出发校验",
-          "type": "boolean"
-        }
-      ],
-      "events": [],
-      "slots": [
-        {
-          "name": null,
-          "description": "表单项内容"
+          "name": "resetValidateState",
+          "params": [],
+          "description": "重置表单校验状态方法",
+          "returns": {}
         }
       ],
-      "methods": [],
       "parts": [],
-      "description": "通用输入框构件",
-      "category": "form-input-basic",
-      "insider": true
+      "description": "表单构件",
+      "category": "form-input-basic"
     },
     {
       "name": "eo-select",
@@ -724,6 +724,7 @@
         },
         {
           "name": "debounceSearchDelay",
+          "description": "设置时，同时对 useBackend 和 search 事件进行防抖。\n未设置时，useBackend 有默认的 300ms 防抖。",
           "type": "number"
         },
         {
@@ -783,142 +784,50 @@
         },
         {
           "name": "cancelText",
-          "description": "取消按钮的文字，不设置则不显示取消按钮",
-          "type": "string"
-        },
-        {
-          "name": "disableAfterClick",
-          "description": "点击确定按钮后自动禁用",
-          "type": "boolean"
-        },
-        {
-          "name": "submitDisabled",
-          "description": "禁用提交按钮",
-          "type": "boolean"
-        },
-        {
-          "name": "submitType",
-          "description": "提交按钮类型",
-          "type": "ButtonType"
-        },
-        {
-          "name": "cancelType",
-          "description": "取消按钮类型",
-          "type": "ButtonType"
-        }
-      ],
-      "events": [
-        {
-          "name": "submit",
-          "description": "点击提交按钮触发的事件",
-          "detail": {
-            "type": "void"
-          }
-        },
-        {
-          "name": "cancel",
-          "description": "点击取消按钮触发的事件",
-          "detail": {
-            "type": "void"
-          }
-        }
-      ],
-      "slots": [],
-      "methods": [],
-      "parts": [],
-      "description": "表单提交按钮",
-      "category": "form-input-basic"
-    },
-    {
-      "name": "eo-checkbox",
-      "alias": [
-        "form.general-checkbox"
-      ],
-      "properties": [
-        {
-          "name": "name",
-          "description": "字段名称",
-          "type": "string"
-        },
-        {
-          "name": "label",
-          "description": "字段说明",
-          "type": "string"
-        },
-        {
-          "name": "value",
-          "description": "值",
-          "attribute": false,
-          "type": "CheckboxValueType[]"
-        },
-        {
-          "name": "options",
-          "description": "多选框选项表",
-          "required": true,
-          "default": "[]",
-          "attribute": false,
-          "type": "CheckboxOptionType[]"
-        },
-        {
-          "name": "type",
-          "description": "类型",
-          "default": "\"default\"",
-          "type": "CheckboxType"
-        },
-        {
-          "name": "disabled",
-          "description": "是否禁用",
-          "type": "boolean"
+          "description": "取消按钮的文字，不设置则不显示取消按钮",
+          "type": "string"
         },
         {
-          "name": "isCustom",
-          "description": "是否为自定义",
-          "default": "false",
+          "name": "disableAfterClick",
+          "description": "点击确定按钮后自动禁用",
           "type": "boolean"
         },
         {
-          "name": "required",
-          "description": "是否必填",
+          "name": "submitDisabled",
+          "description": "禁用提交按钮",
           "type": "boolean"
         },
         {
-          "name": "message",
-          "description": "校验文本",
-          "attribute": false,
-          "type": "Record<string, string>"
-        },
-        {
-          "name": "isGroup",
-          "description": "是否为复选框，为true时，则可设置分组数据 optionGroups",
-          "type": "boolean"
+          "name": "submitType",
+          "description": "提交按钮类型",
+          "type": "ButtonType"
         },
         {
-          "name": "optionGroups",
-          "description": "多选框选项分组数据，需要设置 isGroup 为 true 才生效",
-          "attribute": false,
-          "type": "OptionGroup[]"
+          "name": "cancelType",
+          "description": "取消按钮类型",
+          "type": "ButtonType"
         }
       ],
       "events": [
         {
-          "name": "change",
-          "description": "复选框变化事件",
+          "name": "submit",
+          "description": "点击提交按钮触发的事件",
           "detail": {
-            "type": "CheckboxOptionType[]"
+            "type": "void"
           }
         },
         {
-          "name": "options.change",
-          "description": "复选框变化事件",
+          "name": "cancel",
+          "description": "点击取消按钮触发的事件",
           "detail": {
-            "type": "{\n    options: CheckboxOptionType[];\n    name: string;\n  }"
+            "type": "void"
           }
         }
       ],
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "表单复选框构件",
+      "description": "表单提交按钮",
       "category": "form-input-basic"
     },
     {
@@ -1074,6 +983,98 @@
       "description": "搜索框",
       "category": "interact-basic"
     },
+    {
+      "name": "eo-checkbox",
+      "alias": [
+        "form.general-checkbox"
+      ],
+      "properties": [
+        {
+          "name": "name",
+          "description": "字段名称",
+          "type": "string"
+        },
+        {
+          "name": "label",
+          "description": "字段说明",
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "description": "值",
+          "attribute": false,
+          "type": "CheckboxValueType[]"
+        },
+        {
+          "name": "options",
+          "description": "多选框选项表",
+          "required": true,
+          "default": "[]",
+          "attribute": false,
+          "type": "CheckboxOptionType[]"
+        },
+        {
+          "name": "type",
+          "description": "类型",
+          "default": "\"default\"",
+          "type": "CheckboxType"
+        },
+        {
+          "name": "disabled",
+          "description": "是否禁用",
+          "type": "boolean"
+        },
+        {
+          "name": "isCustom",
+          "description": "是否为自定义",
+          "default": "false",
+          "type": "boolean"
+        },
+        {
+          "name": "required",
+          "description": "是否必填",
+          "type": "boolean"
+        },
+        {
+          "name": "message",
+          "description": "校验文本",
+          "attribute": false,
+          "type": "Record<string, string>"
+        },
+        {
+          "name": "isGroup",
+          "description": "是否为复选框，为true时，则可设置分组数据 optionGroups",
+          "type": "boolean"
+        },
+        {
+          "name": "optionGroups",
+          "description": "多选框选项分组数据，需要设置 isGroup 为 true 才生效",
+          "attribute": false,
+          "type": "OptionGroup[]"
+        }
+      ],
+      "events": [
+        {
+          "name": "change",
+          "description": "复选框变化事件",
+          "detail": {
+            "type": "CheckboxOptionType[]"
+          }
+        },
+        {
+          "name": "options.change",
+          "description": "复选框变化事件",
+          "detail": {
+            "type": "{\n    options: CheckboxOptionType[];\n    name: string;\n  }"
+          }
+        }
+      ],
+      "slots": [],
+      "methods": [],
+      "parts": [],
+      "description": "表单复选框构件",
+      "category": "form-input-basic"
+    },
     {
       "name": "eo-icon-select",
       "alias": [
@@ -1648,24 +1649,27 @@
       "category": "form-input-basic"
     },
     {
-      "name": "eo-time-range-picker",
+      "name": "eo-color-picker",
       "properties": [
         {
           "name": "name",
-          "description": "时间段选择器字段名",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "时间段选择器说明",
+          "description": "字段说明",
           "type": "string"
         },
         {
           "name": "value",
-          "description": "时间段选择器的初始值",
-          "default": "{ \"startTime\": \"00:00:00\", \"endTime\": \"23:59:59\" }",
-          "attribute": false,
-          "type": "TimeRange"
+          "description": "值",
+          "type": "string"
+        },
+        {
+          "name": "defaultValue",
+          "description": "颜色默认的值",
+          "type": "string | Color"
         },
         {
           "name": "required",
@@ -1673,72 +1677,74 @@
           "type": "boolean"
         },
         {
-          "name": "rangeType",
-          "description": "时间段类型",
+          "name": "allowClear",
+          "description": "允许清除选择的颜色",
+          "type": "boolean"
+        },
+        {
+          "name": "size",
+          "description": "设置触发器大小",
+          "default": "middle",
           "attribute": false,
-          "type": "RangeType"
+          "type": "\"small\" | \"middle\" | \"large\""
         },
         {
-          "name": "selectNearDays",
-          "description": "只有rangeType在`date` 和 `dateTime`下， 才支持只选择最近n天(当前时间向前n天)",
-          "type": "number"
+          "name": "showText",
+          "description": "显示颜色文本",
+          "type": "boolean"
         },
         {
-          "name": "emitChangeOnInit",
-          "description": "",
-          "default": "true\n是否在初始化完成后额外触发一次`time.range.change`, 这里因为历史原因之前默认行为就是在初始化后会触发该事件，这里为了兼容之前的行为，默认值只能设置为 true。",
+          "name": "disabled",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
-          "name": "presetRanges",
-          "description": "",
-          "default": "[]\n预设时间范围快捷选择；设置了属性selectNearDays时，属性presetRanges不生效；属性rangeType为week时，presetRanges的值只能为本周、本月、本季度、今年，属性rangeType为month、quarter、year时，以此类推",
+          "name": "format",
+          "description": "颜色格式",
+          "default": "hex",
           "attribute": false,
-          "type": "presetRangeType[]"
+          "type": "\"rgb\" | \"hex\" | \"hsb\""
         },
         {
-          "name": "validator",
+          "name": "configProps",
+          "description": "透传 antd ColorPicker 属性 [ColorPickerProps](https://ant.design/components/color-picker-cn#api)",
           "attribute": false,
-          "type": "((value: any) => MessageBody | string)"
+          "type": "Partial<ColorPickerProps>"
         }
       ],
       "events": [
         {
           "name": "change",
-          "description": "时间段变化时触发",
+          "description": "颜色变化事件, 返回值格式和`format`格式一致",
           "detail": {
-            "type": "TimeRange"
+            "type": "string | undefined"
           }
         }
       ],
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "时间区间选择器",
-      "category": "form-input-basic"
+      "description": "构件 `eo-color-picker`"
     },
     {
-      "name": "eo-color-picker",
+      "name": "eo-time-range-picker",
       "properties": [
         {
           "name": "name",
-          "description": "字段名称",
+          "description": "时间段选择器字段名",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "字段说明",
+          "description": "时间段选择器说明",
           "type": "string"
         },
         {
           "name": "value",
-          "description": "值",
-          "type": "string"
-        },
-        {
-          "name": "defaultValue",
-          "description": "颜色默认的值",
-          "type": "string | Color"
+          "description": "时间段选择器的初始值",
+          "default": "{ \"startTime\": \"00:00:00\", \"endTime\": \"23:59:59\" }",
+          "attribute": false,
+          "type": "TimeRange"
         },
         {
           "name": "required",
@@ -1746,54 +1752,49 @@
           "type": "boolean"
         },
         {
-          "name": "allowClear",
-          "description": "允许清除选择的颜色",
-          "type": "boolean"
-        },
-        {
-          "name": "size",
-          "description": "设置触发器大小",
-          "default": "middle",
+          "name": "rangeType",
+          "description": "时间段类型",
           "attribute": false,
-          "type": "\"small\" | \"middle\" | \"large\""
+          "type": "RangeType"
         },
         {
-          "name": "showText",
-          "description": "显示颜色文本",
-          "type": "boolean"
+          "name": "selectNearDays",
+          "description": "只有rangeType在`date` 和 `dateTime`下， 才支持只选择最近n天(当前时间向前n天)",
+          "type": "number"
         },
         {
-          "name": "disabled",
-          "description": "是否禁用",
+          "name": "emitChangeOnInit",
+          "description": "",
+          "default": "true\n是否在初始化完成后额外触发一次`time.range.change`, 这里因为历史原因之前默认行为就是在初始化后会触发该事件，这里为了兼容之前的行为，默认值只能设置为 true。",
           "type": "boolean"
         },
         {
-          "name": "format",
-          "description": "颜色格式",
-          "default": "hex",
+          "name": "presetRanges",
+          "description": "",
+          "default": "[]\n预设时间范围快捷选择；设置了属性selectNearDays时，属性presetRanges不生效；属性rangeType为week时，presetRanges的值只能为本周、本月、本季度、今年，属性rangeType为month、quarter、year时，以此类推",
           "attribute": false,
-          "type": "\"rgb\" | \"hex\" | \"hsb\""
+          "type": "presetRangeType[]"
         },
         {
-          "name": "configProps",
-          "description": "透传 antd ColorPicker 属性 [ColorPickerProps](https://ant.design/components/color-picker-cn#api)",
+          "name": "validator",
           "attribute": false,
-          "type": "Partial<ColorPickerProps>"
+          "type": "((value: any) => MessageBody | string)"
         }
       ],
       "events": [
         {
           "name": "change",
-          "description": "颜色变化事件, 返回值格式和`format`格式一致",
+          "description": "时间段变化时触发",
           "detail": {
-            "type": "string | undefined"
+            "type": "TimeRange"
           }
         }
       ],
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件 `eo-color-picker`"
+      "description": "时间区间选择器",
+      "category": "form-input-basic"
     }
   ],
   "providers": []