@next-bricks/form 0.10.0 → 0.11.0

package/dist/manifest.json

@@ -4,7 +4,10 @@
   "name": "form",
   "bricks": [
     {
-      "name": "form.general-input",
+      "name": "eo-input",
+      "alias": [
+        "form.general-input"
+      ],
       "properties": [
         {
           "name": "name",
@@ -114,7 +117,10 @@
       "description": "通用输入框构件"
     },
     {
-      "name": "form.general-textarea",
+      "name": "eo-textarea",
+      "alias": [
+        "form.general-textarea"
+      ],
       "properties": [
         {
           "name": "name",
@@ -200,7 +206,10 @@
       "description": "通用多行文本输入框构件"
     },
     {
-      "name": "form.general-form",
+      "name": "eo-form",
+      "alias": [
+        "form.general-form"
+      ],
       "properties": [
         {
           "name": "layout",
@@ -306,90 +315,69 @@
       "description": "表单构件"
     },
     {
-      "name": "form.general-form-item",
+      "name": "eo-form-item",
+      "alias": [
+        "form.general-form-item"
+      ],
       "properties": [
         {
           "name": "formElement",
-          "description": "",
-          "required": true,
-          "default": null,
           "attribute": false,
           "type": "Form"
         },
         {
           "name": "curElement",
-          "description": "",
-          "required": true,
-          "default": null,
           "attribute": false,
           "type": "HTMLElement"
         },
         {
           "name": "name",
-          "description": "",
+          "description": "字段名称",
           "type": "string"
         },
         {
           "name": "label",
-          "description": "",
-          "required": true,
-          "default": null,
           "type": "string"
         },
         {
           "name": "pattern",
-          "description": "",
-          "required": true,
-          "default": null,
           "type": "string"
         },
         {
           "name": "message",
-          "description": "",
-          "required": true,
-          "default": null,
           "attribute": false,
           "type": "Record<string, string>"
         },
         {
           "name": "max",
-          "description": "",
-          "required": true,
-          "default": null,
           "type": "number"
         },
         {
           "name": "min",
-          "description": "",
-          "required": true,
-          "default": null,
           "type": "number"
         },
         {
           "name": "required",
-          "description": "",
+          "description": "表单项是否必填",
           "type": "boolean"
         },
         {
           "name": "value",
-          "description": "",
+          "description": "初始值",
           "type": "string"
         },
         {
           "name": "labelCol",
-          "description": "",
-          "required": true,
+          "description": "表单项 label 标签布局",
           "type": "string"
         },
         {
           "name": "wrapperCol",
-          "description": "",
-          "required": true,
+          "description": "表单项控件布局",
           "type": "string"
         },
         {
           "name": "valuePropsName",
-          "description": "",
           "type": "string"
         },
         {
@@ -399,42 +387,40 @@
         },
         {
           "name": "size",
-          "description": "",
           "type": "ComponentSize"
         },
         {
           "name": "trim",
-          "description": "",
+          "description": "是否自动去除前后的空白字符",
           "default": "true"
         },
         {
           "name": "trigger",
-          "description": "",
-          "default": "false",
+          "description": "事件触发方法名",
           "type": "string"
         },
         {
           "name": "validator",
-          "description": "",
-          "default": "false",
+          "description": "表单项校验方法",
           "attribute": false,
           "type": "((value: any) => MessageBody)"
         },
         {
           "name": "needValidate",
-          "description": "",
-          "required": true,
-          "default": null,
+          "description": "值变化时是否主动出发校验",
           "type": "boolean"
         }
       ],
       "events": [],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "通用输入框构件"
     },
     {
-      "name": "form.general-radio",
+      "name": "eo-radio",
+      "alias": [
+        "form.general-radio"
+      ],
       "properties": [
         {
           "name": "name",
@@ -527,7 +513,10 @@
       "description": "通用单选构件"
     },
     {
-      "name": "form.general-select",
+      "name": "eo-select",
+      "alias": [
+        "form.general-select"
+      ],
       "properties": [
         {
           "name": "name",
@@ -612,7 +601,10 @@
       "description": "通用下拉选择构件"
     },
     {
-      "name": "form.submit-buttons",
+      "name": "eo-submit-buttons",
+      "alias": [
+        "form.submit-buttons"
+      ],
       "properties": [
         {
           "name": "submitText",
@@ -667,7 +659,10 @@
       "description": "用于general-forms的通用按钮"
     },
     {
-      "name": "form.general-checkbox",
+      "name": "eo-checkbox",
+      "alias": [
+        "form.general-checkbox"
+      ],
       "properties": [
         {
           "name": "name",
@@ -924,7 +919,10 @@
       "description": ""
     },
     {
-      "name": "form.dynamic-form-item",
+      "name": "eo-dynamic-form-item",
+      "alias": [
+        "form.dynamic-form-item"
+      ],
       "properties": [
         {
           "name": "name",
@@ -964,10 +962,13 @@
       ],
       "slots": [],
       "methods": [],
-      "description": ""
+      "description": "动态表单"
     },
     {
-      "name": "form.general-search",
+      "name": "eo-search",
+      "alias": [
+        "form.general-search"
+      ],
       "properties": [
         {
           "name": "value",
@@ -1030,7 +1031,10 @@
       "description": "搜索框"
     },
     {
-      "name": "form.icon-select",
+      "name": "eo-icon-select",
+      "alias": [
+        "form.icon-select"
+      ],
       "properties": [
         {
           "name": "name",
@@ -1079,7 +1083,10 @@
       "description": "图标选择构件"
     },
     {
-      "name": "form.upload-image",
+      "name": "eo-upload-image",
+      "alias": [
+        "form.upload-image"
+      ],
       "properties": [
         {
           "name": "name",
@@ -1133,7 +1140,10 @@
       "description": "上传图片构件"
     },
     {
-      "name": "form.general-switch",
+      "name": "eo-switch",
+      "alias": [
+        "form.general-switch"
+      ],
       "properties": [
         {
           "name": "name",
@@ -1194,7 +1204,7 @@
       ],
       "slots": [],
       "methods": [],
-      "description": "构件 general-switch"
+      "description": "构件 eo-switch"
     }
   ],
   "providers": []

package/dist/types.json

@@ -1,5 +1,5 @@
 {
-  "form.general-form-item": {
+  "eo-form-item": {
     "properties": [
       {
         "name": "formElement",
@@ -233,7 +233,7 @@
       }
     ]
   },
-  "form.submit-buttons": {
+  "eo-submit-buttons": {
     "properties": [
       {
         "name": "submitText",
@@ -341,7 +341,7 @@
       }
     ]
   },
-  "form.dynamic-form-item": {
+  "eo-dynamic-form-item": {
     "properties": [
       {
         "name": "name",
@@ -433,7 +433,7 @@
       }
     ]
   },
-  "form.general-search": {
+  "eo-search": {
     "properties": [
       {
         "name": "value",
@@ -509,7 +509,7 @@
     ],
     "methods": []
   },
-  "form.general-switch": {
+  "eo-switch": {
     "properties": [
       {
         "name": "name",
@@ -624,7 +624,7 @@
       }
     ]
   },
-  "form.general-form": {
+  "eo-form": {
     "properties": [
       {
         "name": "layout",
@@ -873,7 +873,7 @@
       }
     ]
   },
-  "form.general-select": {
+  "eo-select": {
     "properties": [
       {
         "name": "name",
@@ -1191,7 +1191,7 @@
       }
     ]
   },
-  "form.general-checkbox": {
+  "eo-checkbox": {
     "properties": [
       {
         "name": "name",
@@ -1491,7 +1491,7 @@
       }
     ]
   },
-  "form.general-input": {
+  "eo-input": {
     "properties": [
       {
         "name": "name",
@@ -1775,7 +1775,7 @@
       }
     ]
   },
-  "form.general-textarea": {
+  "eo-textarea": {
     "properties": [
       {
         "name": "name",
@@ -1955,7 +1955,7 @@
       }
     ]
   },
-  "form.icon-select": {
+  "eo-icon-select": {
     "properties": [
       {
         "name": "name",
@@ -2080,7 +2080,7 @@
       }
     ]
   },
-  "form.general-radio": {
+  "eo-radio": {
     "properties": [
       {
         "name": "name",
@@ -2537,7 +2537,7 @@
       }
     ]
   },
-  "form.upload-image": {
+  "eo-upload-image": {
     "properties": [
       {
         "name": "name",

package/dist-types/dynamic-form-item/index.d.ts

@@ -4,12 +4,8 @@ import "@next-core/theme";
 import { FormItemElementBase } from "@next-shared/form";
 type DynamicFormValuesItem = Record<string, any>;
 /**
- * @id form.dynamic-form-item
- * @name form.dynamic-form-item
- * @docKind brick
- * @description 动态表单
+ * 动态表单
  * @author sailor
- * @noInheritDoc
  */
 declare class DynamicFormItem extends FormItemElementBase {
     #private;

package/dist-types/form-item/index.d.ts

@@ -29,133 +29,59 @@ export interface FormItemProps {
     validator?: (value: any) => MessageBody | string;
 }
 /**
- * @id form.general-form
- * @name form.general-form
- * @docKind brick
- * @description 通用输入框构件
+ * 通用输入框构件
  * @author sailor
- * @noInheritDoc
  */
 declare class FormItem extends FormItemElementBase implements FormItemProps {
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor formElement: Form | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor curElement: HTMLElement;
     /**
-     * @kind string
-     * @required false
-     * @default default
-     * @description 字段名称
-     * @enums
-     * @group basic
+     * 字段名称
      */
     accessor name: string | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor label: string | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor pattern: string | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor message: Record<string, string> | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor max: number | undefined;
-    /**
-     * @default
-     * @required
-     * @description
-     */
     accessor min: number | undefined;
     /**
-     * @kind boolean
-     * @required false
-     * @default -
-     * @description 表单项是否必填
+     * 表单项是否必填
      * @group basicFormItem
      */
     accessor required: boolean | undefined;
     /**
-     * @kind string
-     * @required false
-     * @default default
-     * @description 初始值
-     * @enums
-     * @group basic
+     * 初始值
      */
     accessor value: string | undefined;
     /**
-     * @required false
-     * @description 表单项 label 标签布局
+     * 表单项 label 标签布局
      * @group ui
      */
     accessor labelCol: string | undefined;
     /**
-     * @required false
-     * @description 表单项控件布局
+     * 表单项控件布局
      * @group ui
      */
     accessor wrapperCol: string | undefined;
-    /**
-     * @kind string
-     * @required false
-     * @default default
-     * @description 初始值
-     * @enums
-     * @group basic
-     */
     accessor valuePropsName: string | undefined;
     accessor layout: Layout;
-    /**
-     * @kind string
-     * @required false
-     * @default default
-     * @description 初始值
-     * @enums
-     * @group basic
-     */
     accessor size: ComponentSize | undefined;
     /**
+     * 是否自动去除前后的空白字符
      * @default true
-     * @description 是否自动去除前后的空白字符
      * @group advancedFormItem
      */
     accessor trim: boolean;
     /**
-     * @default false
-     * @description 事件触发方法名
+     * 事件触发方法名
      */
     accessor trigger: string;
     /**
-     * @default false
-     * @description 表单项校验方法
+     * 表单项校验方法
      */
     accessor validator: ((value: any) => MessageBody) | undefined;
     /**
-     * @default
-     * @required
-     * @description 值变化时是否主动出发校验
+     * 值变化时是否主动出发校验
      */
     accessor needValidate: boolean | undefined;
     render(): JSX.Element;

package/dist-types/general-switch/index.d.ts

@@ -16,7 +16,7 @@ interface SwitchProps extends FormItemProps {
     unCheckedIcon?: GeneralIconProps;
 }
 /**
- * 构件 general-switch
+ * 构件 eo-switch
  * @author zhendonghuang
  */
 export declare class GeneralSwitch extends FormItemElementBase {

package/docs/{general-checkbox.md → eo-checkbox.md}

@@ -1,7 +1,7 @@
 表单复选框构件。
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     options:
       - Beijing
@@ -15,7 +15,7 @@
 ### Label
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     label: city
     options:
@@ -28,7 +28,7 @@
 ### Value
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     value:
       - Beijing
@@ -43,7 +43,7 @@
 ### Options
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     options:
       - Beijing
@@ -52,7 +52,7 @@
       - Shenzhen
     value:
       - Guangzhou
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     options:
       - label: Beijing
@@ -69,7 +69,7 @@
     value:
       - 2
       - 3
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     options:
       - true
@@ -81,7 +81,7 @@
 ### Disabled
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     options:
       - label: Beijing
@@ -97,7 +97,7 @@
   properties:
     style:
       height: 20px
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     disabled: true
     options:
@@ -114,7 +114,7 @@
 ### Type
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     label: Default
     type: default
@@ -143,7 +143,7 @@
   properties:
     style:
       height: 20px
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     label: Icon
     type: icon
@@ -173,7 +173,7 @@
 ### Event
 
 ```yaml preview
-- brick: form.general-checkbox
+- brick: eo-checkbox
   properties:
     id: option-checkbox
     options:
@@ -197,7 +197,7 @@
       - action: message.success
         args:
           - <% JSON.stringify(EVENT.detail) %>
-- brick: basic.general-button
+- brick: eo-button
   properties:
     textContent: Click to Change Radio Option
   events: