@next-bricks/form 0.5.0 → 0.6.0

package/dist/manifest.json

@@ -8,88 +8,85 @@
       "properties": [
         {
           "name": "name",
-          "description": "",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "标签文字",
           "type": "string"
         },
         {
           "name": "value",
-          "description": "",
+          "description": "输入框值",
           "type": "string"
         },
         {
           "name": "placeholder",
-          "description": "",
+          "description": "占位说明",
           "type": "string"
         },
         {
           "name": "disabled",
-          "description": "",
+          "description": "是否禁用",
+          "type": "boolean"
+        },
+        {
+          "name": "clearable",
+          "description": "是否显示清除按钮",
           "type": "boolean"
         },
         {
           "name": "type",
-          "description": "",
+          "description": "类型",
+          "default": "\"text\"",
           "type": "InputType"
         },
         {
           "name": "size",
-          "description": "",
+          "description": "大小",
+          "default": "\"medium\"",
           "type": "ComponentSize"
         },
         {
           "name": "minLength",
-          "description": "",
+          "description": "最小长度",
           "type": "number"
         },
         {
           "name": "maxLength",
-          "description": "",
+          "description": "最大长度",
           "type": "number"
         },
         {
           "name": "required",
-          "description": "",
+          "description": "是否必填",
           "type": "boolean"
         },
         {
           "name": "pattern",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "正则校验规则",
           "type": "string"
         },
         {
           "name": "max",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "表单校验最大长度",
           "type": "number"
         },
         {
           "name": "min",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "表单校验最小长度",
           "type": "number"
         },
         {
           "name": "message",
-          "description": "",
-          "required": true,
-          "default": null,
-          "attribute": true,
+          "description": "错误时显示消息",
+          "attribute": false,
           "type": "Record<string, string>"
         },
         {
           "name": "inputStyle",
-          "description": "",
+          "description": "输入框样式",
           "attribute": false,
           "type": "React.CSSProperties"
         }
@@ -97,71 +94,93 @@
       "events": [
         {
           "name": "change",
-          "description": "",
+          "description": "值改变事件",
           "detail": {
-            "description": null,
             "type": "string"
           }
         }
       ],
-      "slots": [],
+      "slots": [
+        {
+          "name": "prefix",
+          "description": "输入框前置插槽"
+        },
+        {
+          "name": "suffix",
+          "description": "输入框后置插槽"
+        }
+      ],
       "methods": [],
-      "description": ""
+      "description": "通用输入框构件"
     },
     {
       "name": "form.general-textarea",
       "properties": [
         {
           "name": "name",
-          "description": "",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "标签文字",
           "type": "string"
         },
         {
           "name": "value",
-          "description": "",
+          "description": "值",
           "type": "string"
         },
         {
           "name": "placeholder",
-          "description": "",
+          "description": "占位说明",
           "type": "string"
         },
         {
           "name": "disabled",
-          "description": "",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
           "name": "minLength",
-          "description": "",
+          "description": "最小长度",
           "type": "number"
         },
         {
           "name": "maxLength",
-          "description": "",
+          "description": "最大长度",
           "type": "number"
         },
         {
           "name": "autoSize",
-          "description": "",
+          "description": "大小自适应",
           "attribute": false,
           "type": "AutoSize"
         },
         {
           "name": "required",
-          "description": "",
+          "description": "是否必填",
           "type": "boolean"
         },
+        {
+          "name": "max",
+          "description": "表单校验最大长度",
+          "type": "number"
+        },
+        {
+          "name": "min",
+          "description": "表单校验最小长度",
+          "type": "number"
+        },
+        {
+          "name": "message",
+          "description": "校验信息",
+          "attribute": false,
+          "type": "Record<string, string>"
+        },
         {
           "name": "textareaStyle",
-          "description": "",
+          "description": "自定义样式",
           "attribute": false,
           "type": "React.CSSProperties"
         }
@@ -178,24 +197,26 @@
       ],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "通用多行文本输入框构件"
     },
     {
       "name": "form.general-form",
       "properties": [
         {
           "name": "layout",
+          "description": "布局方式",
           "type": "Layout"
         },
         {
           "name": "size",
+          "description": "表单组件尺寸",
           "type": "ComponentSize"
         }
       ],
       "events": [
         {
           "name": "values.change",
-          "description": "",
+          "description": "表单值变更事件",
           "detail": {
             "description": null,
             "type": "Record<string, unknown>"
@@ -203,25 +224,30 @@
         },
         {
           "name": "validate.success",
-          "description": "",
+          "description": "表单验证成功时触发事件",
           "detail": {
             "type": "Record<string, unknown>"
           }
         },
         {
           "name": "validate.error",
-          "description": "",
+          "description": "表单验证报错时触发事件",
           "detail": {
             "type": "MessageBody[]"
           }
         }
       ],
-      "slots": [],
+      "slots": [
+        {
+          "name": null,
+          "description": "表单内容"
+        }
+      ],
       "methods": [
         {
           "name": "validate",
           "params": [],
-          "description": "",
+          "description": "表单校验方法",
           "return": {
             "type": "boolean | Record<string, unknown>"
           }
@@ -231,36 +257,36 @@
           "params": [
             "values: Record<string, unknown>"
           ],
-          "description": ""
+          "description": "表单设置值方法"
         },
         {
           "name": "resetFields",
           "params": [
             "name?: string"
           ],
-          "description": ""
+          "description": "表单重置值方法"
         },
         {
           "name": "getFieldsValue",
           "params": [
-            "name: string"
+            "name?: string"
           ],
-          "description": ""
+          "description": "获取表单值方法"
         },
         {
           "name": "validateField",
           "params": [
             "name: string"
           ],
-          "description": ""
+          "description": "校验表单字段方法"
         },
         {
           "name": "resetValidateState",
           "params": [],
-          "description": ""
+          "description": "重置表单校验状态方法"
         }
       ],
-      "description": ""
+      "description": "表单构件"
     },
     {
       "name": "form.general-form-item",
@@ -305,7 +331,7 @@
           "description": "",
           "required": true,
           "default": null,
-          "attribute": true,
+          "attribute": false,
           "type": "Record<string, string>"
         },
         {
@@ -395,67 +421,70 @@
       "properties": [
         {
           "name": "name",
-          "description": "",
+          "description": "下拉框字段名",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "",
+          "description": "单选框字段说明",
           "type": "string"
         },
         {
           "name": "options",
-          "description": "",
+          "description": "单选框选项表",
           "required": true,
-          "default": "-",
           "attribute": false,
           "type": "GeneralOption[]"
         },
         {
           "name": "value",
-          "description": "",
+          "description": "单选框当前选中始值",
+          "attribute": false,
           "type": "any"
         },
         {
           "name": "required",
-          "description": "",
+          "description": "是否必填",
           "type": "boolean"
         },
         {
           "name": "message",
-          "description": "",
+          "description": "校验文本信息",
           "attribute": false,
           "type": "Record<string, string>"
         },
         {
           "name": "disabled",
-          "description": "",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
           "name": "type",
-          "description": "",
+          "description": "单选框样式类型",
+          "default": "\"default\"",
           "type": "RadioType"
         },
         {
           "name": "ui",
-          "description": "",
+          "description": "UI样式",
+          "default": "\"default\"",
           "type": "UIType"
         },
         {
           "name": "size",
-          "description": "",
-          "type": "\"large\" | \"medium\" | \"small\""
+          "description": "大小，只对按钮样式生效",
+          "default": "\"medium\"",
+          "type": "ComponentSize"
         },
         {
           "name": "customStyle",
-          "description": "",
+          "description": "自定义radio的外层样式",
           "attribute": false,
           "type": "React.CSSProperties"
         },
         {
           "name": "useBrick",
-          "description": "",
+          "description": "自定义radio的内容",
           "attribute": false,
           "type": "UseSingleBrickConf"
         }
@@ -463,233 +492,238 @@
       "events": [
         {
           "name": "change",
-          "description": "",
+          "description": "值变化事件",
           "detail": {
-            "description": "`{label: string, value: any, [key: string]: any}\t`",
             "type": "{\n    label: string;\n    value: any;\n    [key: string]: any;\n  }"
           }
         },
         {
-          "name": "optionsChange",
-          "description": "",
+          "name": "options.change",
+          "description": "选项列表变化事件",
           "detail": {
-            "description": "`{options:{label: string, value: any, [key: string]: any},name:string}\t`",
             "type": "{\n    options: {\n      label: string;\n      value: any;\n      [key: string]: any;\n    };\n    name: string;\n  }"
           }
         }
       ],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "通用单选构件"
     },
     {
       "name": "form.general-select",
       "properties": [
         {
           "name": "name",
-          "description": "",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "placeholder",
-          "description": "",
+          "description": "占位说明",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "",
+          "description": "字段文本",
           "type": "string"
         },
         {
           "name": "options",
-          "description": "",
+          "description": "选项列表",
           "required": true,
-          "default": "-",
           "attribute": false,
           "type": "GeneralComplexOption[]"
         },
         {
           "name": "value",
-          "description": "",
+          "description": "值",
           "attribute": false,
           "type": "any"
         },
         {
           "name": "required",
-          "description": "",
+          "description": "是否必填",
           "type": "boolean"
         },
         {
           "name": "message",
-          "description": "",
+          "description": "校验文本信息",
           "attribute": false,
           "type": "Record<string, string>"
         },
         {
           "name": "disabled",
-          "description": "",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
           "name": "multiple",
-          "description": "",
+          "description": "是否支持多选",
           "type": "boolean"
         },
         {
           "name": "clearable",
-          "description": "",
+          "description": "是否支持清除",
+          "default": "true",
           "type": "boolean"
         },
         {
           "name": "inputStyle",
-          "description": "",
+          "description": "输入框样式",
           "attribute": false,
           "type": "React.CSSProperties"
-        },
-        {
-          "name": "dropdownStyle",
-          "description": "",
-          "type": "React.CSSProperties"
         }
       ],
       "events": [
         {
           "name": "change",
-          "description": "",
+          "description": "下拉选择事件",
           "detail": {
-            "description": "`{label: string, value: any, [key: string]: any}\t`",
             "type": "{\n    value: string | string[];\n    options: GeneralComplexOption[];\n  }"
           }
         },
         {
           "name": "options.change",
-          "description": "",
+          "description": "选项列表变化事件",
           "detail": {
-            "description": "`{options:{label: string, value: any, [key: string]: any},name:string}\t`",
             "type": "{\n    options: {\n      label: string;\n      value: any;\n      [key: string]: any;\n    };\n    name: string;\n  }"
           }
         }
       ],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "通用下拉选择构件"
     },
     {
       "name": "form.submit-buttons",
       "properties": [
         {
           "name": "submitText",
-          "description": "",
+          "description": "提交按钮的文字",
+          "default": "\"提交\"",
           "type": "string"
         },
-        {
-          "name": "showCancelButton",
-          "description": "",
-          "type": "boolean"
-        },
         {
           "name": "cancelText",
-          "description": "",
+          "description": "取消按钮的文字，不设置则不显示取消按钮",
           "type": "string"
         },
         {
           "name": "disableAfterClick",
-          "description": "",
+          "description": "点击确定按钮后自动禁用",
           "type": "boolean"
         },
         {
           "name": "submitDisabled",
-          "description": "",
+          "description": "禁用提交按钮",
           "type": "boolean"
         },
         {
           "name": "submitType",
-          "description": "",
+          "description": "提交按钮类型",
           "type": "ButtonType"
         },
         {
           "name": "cancelType",
-          "description": "",
+          "description": "取消按钮类型",
           "type": "ButtonType"
         }
       ],
       "events": [
         {
           "name": "submit",
-          "description": "",
+          "description": "点击提交按钮触发的事件",
           "detail": {
-            "description": "-",
             "type": "void"
           }
         },
         {
           "name": "cancel",
-          "description": "",
+          "description": "点击取消按钮触发的事件",
           "detail": {
-            "description": "-",
             "type": "void"
           }
         }
       ],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "用于general-forms的通用按钮"
     },
     {
       "name": "form.general-checkbox",
       "properties": [
+        {
+          "name": "name",
+          "description": "字段名称",
+          "type": "string"
+        },
+        {
+          "name": "label",
+          "description": "字段说明",
+          "type": "string"
+        },
         {
           "name": "value",
-          "description": "",
+          "description": "值",
           "attribute": false,
-          "type": "string[]"
+          "type": "CheckboxValueType[]"
         },
         {
           "name": "options",
-          "description": "",
+          "description": "多选框选项表",
           "required": true,
-          "default": "-",
+          "default": "[]",
           "attribute": false,
           "type": "CheckboxOptionType[]"
         },
-        {
-          "name": "name",
-          "description": "",
-          "attribute": false,
-          "type": "string"
-        },
-        {
-          "name": "label",
-          "description": "",
-          "type": "string"
-        },
         {
           "name": "type",
-          "description": "",
+          "description": "类型",
           "default": "\"default\"",
-          "attribute": false,
           "type": "CheckboxType"
         },
+        {
+          "name": "disabled",
+          "description": "是否禁用",
+          "type": "boolean"
+        },
         {
           "name": "isCustom",
-          "description": "",
+          "description": "是否为自定义",
           "default": "false",
-          "attribute": false,
           "type": "boolean"
+        },
+        {
+          "name": "required",
+          "description": "是否必填",
+          "type": "boolean"
+        },
+        {
+          "name": "message",
+          "description": "校验文本",
+          "attribute": false,
+          "type": "Record<string, string>"
         }
       ],
       "events": [
         {
           "name": "change",
-          "description": "",
+          "description": "复选框变化事件",
           "detail": {
-            "description": null,
             "type": "CheckboxOptionType[]"
           }
+        },
+        {
+          "name": "options.change",
+          "description": "复选框变化事件",
+          "detail": {
+            "type": "{\n    options: CheckboxOptionType[];\n    name: string;\n  }"
+          }
         }
       ],
       "slots": [],
-      "methods": []
+      "methods": [],
+      "description": "表单复选框构件"
     },
     {
       "name": "form.code-editor",
@@ -877,29 +911,28 @@
       "properties": [
         {
           "name": "name",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "label",
+          "description": "字段说明",
           "type": "string"
         },
         {
           "name": "required",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "是否必填",
           "type": "boolean"
         },
         {
           "name": "value",
+          "description": "值",
           "attribute": false,
           "type": "DynamicFormValuesItem[]"
         },
         {
           "name": "useBrick",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "动态表单子项构件列表",
           "attribute": false,
           "type": "UseBrickConf"
         }
@@ -978,6 +1011,55 @@
       "slots": [],
       "methods": [],
       "description": "搜索框"
+    },
+    {
+      "name": "form.icon-select",
+      "properties": [
+        {
+          "name": "name",
+          "description": "字段名称",
+          "type": "string"
+        },
+        {
+          "name": "label",
+          "description": "字段说明",
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "description": "值",
+          "attribute": false,
+          "type": "Icon"
+        },
+        {
+          "name": "disabled",
+          "description": "是否禁用",
+          "type": "boolean"
+        },
+        {
+          "name": "required",
+          "description": "是否必填",
+          "type": "boolean"
+        },
+        {
+          "name": "message",
+          "description": "是否必填",
+          "attribute": false,
+          "type": "Record<string, string>"
+        }
+      ],
+      "events": [
+        {
+          "name": "change",
+          "description": "值变化时触发",
+          "detail": {
+            "type": "Icon | undefined"
+          }
+        }
+      ],
+      "slots": [],
+      "methods": [],
+      "description": "图标选择构件"
     }
   ]
 }