@next-bricks/advanced 0.51.3 → 0.51.4

package/dist/types.json

@@ -285,6 +285,240 @@
       }
     ]
   },
+  "eo-workbench-layout": {
+    "properties": [
+      {
+        "name": "cardTitle",
+        "annotation": {
+          "type": "keyword",
+          "value": "string"
+        }
+      },
+      {
+        "name": "isEdit",
+        "annotation": {
+          "type": "keyword",
+          "value": "boolean"
+        }
+      },
+      {
+        "name": "layouts",
+        "annotation": {
+          "type": "array",
+          "elementType": {
+            "type": "reference",
+            "typeName": {
+              "type": "identifier",
+              "name": "Layout"
+            }
+          }
+        }
+      },
+      {
+        "name": "componentList",
+        "annotation": {
+          "type": "array",
+          "elementType": {
+            "type": "reference",
+            "typeName": {
+              "type": "identifier",
+              "name": "Item"
+            }
+          }
+        }
+      }
+    ],
+    "events": [
+      {
+        "name": "change",
+        "detail": {
+          "annotation": {
+            "type": "array",
+            "elementType": {
+              "type": "reference",
+              "typeName": {
+                "type": "identifier",
+                "name": "Layout"
+              }
+            }
+          }
+        }
+      },
+      {
+        "name": "save",
+        "detail": {
+          "annotation": {
+            "type": "array",
+            "elementType": {
+              "type": "reference",
+              "typeName": {
+                "type": "identifier",
+                "name": "Layout"
+              }
+            }
+          }
+        }
+      },
+      {
+        "name": "cancel",
+        "detail": {
+          "annotation": {
+            "type": "keyword",
+            "value": "void"
+          }
+        }
+      },
+      {
+        "name": "action.click",
+        "detail": {
+          "annotation": {
+            "type": "typeLiteral",
+            "members": [
+              {
+                "type": "propertySignature",
+                "key": {
+                  "type": "identifier",
+                  "name": "action"
+                },
+                "annotation": {
+                  "type": "reference",
+                  "typeName": {
+                    "type": "identifier",
+                    "name": "SimpleAction"
+                  }
+                },
+                "computed": false
+              },
+              {
+                "type": "propertySignature",
+                "key": {
+                  "type": "identifier",
+                  "name": "layouts"
+                },
+                "annotation": {
+                  "type": "array",
+                  "elementType": {
+                    "type": "reference",
+                    "typeName": {
+                      "type": "identifier",
+                      "name": "Layout"
+                    }
+                  }
+                },
+                "computed": false
+              }
+            ]
+          }
+        }
+      }
+    ],
+    "methods": [
+      {
+        "name": "setLayouts",
+        "params": [
+          {
+            "name": "layouts",
+            "annotation": {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "Layout"
+                }
+              }
+            }
+          }
+        ],
+        "returns": {}
+      }
+    ],
+    "types": [
+      {
+        "type": "interface",
+        "name": "Item",
+        "body": [
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "position"
+            },
+            "annotation": {
+              "type": "reference",
+              "typeName": {
+                "type": "identifier",
+                "name": "Layout"
+              }
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "key"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "title"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "style"
+            },
+            "annotation": {
+              "type": "reference",
+              "typeName": {
+                "type": "qualifiedName",
+                "left": {
+                  "type": "identifier",
+                  "name": "React"
+                },
+                "right": {
+                  "type": "identifier",
+                  "name": "CSSProperties"
+                }
+              }
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "useBrick"
+            },
+            "annotation": {
+              "type": "reference",
+              "typeName": {
+                "type": "identifier",
+                "name": "UseSingleBrickConf"
+              }
+            },
+            "computed": false
+          }
+        ]
+      }
+    ]
+  },
   "eo-tree": {
     "properties": [
       {
@@ -1099,240 +1333,6 @@
     "events": [],
     "methods": []
   },
-  "eo-workbench-layout": {
-    "properties": [
-      {
-        "name": "cardTitle",
-        "annotation": {
-          "type": "keyword",
-          "value": "string"
-        }
-      },
-      {
-        "name": "isEdit",
-        "annotation": {
-          "type": "keyword",
-          "value": "boolean"
-        }
-      },
-      {
-        "name": "layouts",
-        "annotation": {
-          "type": "array",
-          "elementType": {
-            "type": "reference",
-            "typeName": {
-              "type": "identifier",
-              "name": "Layout"
-            }
-          }
-        }
-      },
-      {
-        "name": "componentList",
-        "annotation": {
-          "type": "array",
-          "elementType": {
-            "type": "reference",
-            "typeName": {
-              "type": "identifier",
-              "name": "Item"
-            }
-          }
-        }
-      }
-    ],
-    "events": [
-      {
-        "name": "change",
-        "detail": {
-          "annotation": {
-            "type": "array",
-            "elementType": {
-              "type": "reference",
-              "typeName": {
-                "type": "identifier",
-                "name": "Layout"
-              }
-            }
-          }
-        }
-      },
-      {
-        "name": "save",
-        "detail": {
-          "annotation": {
-            "type": "array",
-            "elementType": {
-              "type": "reference",
-              "typeName": {
-                "type": "identifier",
-                "name": "Layout"
-              }
-            }
-          }
-        }
-      },
-      {
-        "name": "cancel",
-        "detail": {
-          "annotation": {
-            "type": "keyword",
-            "value": "void"
-          }
-        }
-      },
-      {
-        "name": "action.click",
-        "detail": {
-          "annotation": {
-            "type": "typeLiteral",
-            "members": [
-              {
-                "type": "propertySignature",
-                "key": {
-                  "type": "identifier",
-                  "name": "action"
-                },
-                "annotation": {
-                  "type": "reference",
-                  "typeName": {
-                    "type": "identifier",
-                    "name": "SimpleAction"
-                  }
-                },
-                "computed": false
-              },
-              {
-                "type": "propertySignature",
-                "key": {
-                  "type": "identifier",
-                  "name": "layouts"
-                },
-                "annotation": {
-                  "type": "array",
-                  "elementType": {
-                    "type": "reference",
-                    "typeName": {
-                      "type": "identifier",
-                      "name": "Layout"
-                    }
-                  }
-                },
-                "computed": false
-              }
-            ]
-          }
-        }
-      }
-    ],
-    "methods": [
-      {
-        "name": "setLayouts",
-        "params": [
-          {
-            "name": "layouts",
-            "annotation": {
-              "type": "array",
-              "elementType": {
-                "type": "reference",
-                "typeName": {
-                  "type": "identifier",
-                  "name": "Layout"
-                }
-              }
-            }
-          }
-        ],
-        "returns": {}
-      }
-    ],
-    "types": [
-      {
-        "type": "interface",
-        "name": "Item",
-        "body": [
-          {
-            "type": "propertySignature",
-            "key": {
-              "type": "identifier",
-              "name": "position"
-            },
-            "annotation": {
-              "type": "reference",
-              "typeName": {
-                "type": "identifier",
-                "name": "Layout"
-              }
-            },
-            "computed": false
-          },
-          {
-            "type": "propertySignature",
-            "key": {
-              "type": "identifier",
-              "name": "key"
-            },
-            "annotation": {
-              "type": "keyword",
-              "value": "string"
-            },
-            "computed": false
-          },
-          {
-            "type": "propertySignature",
-            "key": {
-              "type": "identifier",
-              "name": "title"
-            },
-            "annotation": {
-              "type": "keyword",
-              "value": "string"
-            },
-            "computed": false
-          },
-          {
-            "type": "propertySignature",
-            "key": {
-              "type": "identifier",
-              "name": "style"
-            },
-            "annotation": {
-              "type": "reference",
-              "typeName": {
-                "type": "qualifiedName",
-                "left": {
-                  "type": "identifier",
-                  "name": "React"
-                },
-                "right": {
-                  "type": "identifier",
-                  "name": "CSSProperties"
-                }
-              }
-            },
-            "optional": true,
-            "computed": false
-          },
-          {
-            "type": "propertySignature",
-            "key": {
-              "type": "identifier",
-              "name": "useBrick"
-            },
-            "annotation": {
-              "type": "reference",
-              "typeName": {
-                "type": "identifier",
-                "name": "UseSingleBrickConf"
-              }
-            },
-            "computed": false
-          }
-        ]
-      }
-    ]
-  },
   "advanced.pdf-viewer": {
     "properties": [
       {

package/dist-types/cascader/index.d.ts

@@ -34,23 +34,41 @@ export interface CascaderEventsMapping {
  */
 export declare class CascaderBrick extends FormItemElementBase implements CascaderProps {
     #private;
+    /** 表单字段名 */
     accessor name: string | undefined;
+    /** 表单字段标签 */
     accessor label: string | undefined;
+    /** 是否为必填项 */
     accessor required: boolean | undefined;
+    /** 可选项数据源 */
     accessor options: AntdCascaderProps["options"];
+    /** 自定义字段名，指定 label、value、children 对应的字段 */
     accessor fieldNames: AntdCascaderProps["fieldNames"];
+    /** 当前选中的值 */
     accessor value: AntdCascaderProps["value"];
+    /** 输入框占位文本 */
     accessor placeholder: string | undefined;
+    /** 是否支持多选 */
     accessor multiple: boolean | undefined;
+    /** 是否禁用 */
     accessor disabled: boolean | undefined;
+    /** 是否支持清除 */
     accessor allowClear: boolean | undefined;
+    /** 是否支持搜索，开启后可通过输入关键字过滤选项 */
     accessor showSearch: boolean | undefined;
+    /** 自定义下拉箭头图标 */
     accessor suffixIcon: GeneralIconProps | undefined;
+    /** 次级菜单的展开方式，可选 click 或 hover */
     accessor expandTrigger: AntdCascaderProps["expandTrigger"];
+    /** 浮层预设位置，可选 bottomLeft、bottomRight、topLeft、topRight */
     accessor popupPlacement: AntdCascaderProps["placement"];
+    /** 输入框大小，可选 large、middle、small */
     accessor size: AntdCascaderProps["size"];
+    /** 搜索结果的最大条数，0 表示不限制 */
     accessor limit: number | undefined;
+    /** 多选模式下最多显示的 tag 数量，设为 responsive 时会自适应宽度 */
     accessor maxTagCount: number | "responsive" | undefined;
+    /** 级联选择器的内联样式 */
     accessor cascaderStyle: CSSProperties | undefined;
     handleOnChange: (value: AntdCascaderProps["value"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][]) => void;
     render(): React.JSX.Element;

package/dist-types/next-table/index.d.ts

@@ -63,7 +63,7 @@ export declare class EoNextTable extends ReactNextElement implements NextTablePr
      */
     accessor columns: Column[] | undefined;
     /**
-     * 单元格
+     * 单元格统一配置，可配置 useBrick 自定义渲染所有单元格及表头
      */
     accessor cell: CellConfig | undefined;
     /**
@@ -156,6 +156,7 @@ export declare class EoNextTable extends ReactNextElement implements NextTablePr
     accessor themeVariant: "default" | "elevo" | undefined;
     /**
      * 前端搜索
+     * @param params - 搜索参数，q 为搜索关键词
      */
     search(params: {
         q: string;

package/dist-types/pdf-viewer/index.d.ts

@@ -10,12 +10,18 @@ export interface PdfViewerProps {
     viewerStyle?: React.CSSProperties | undefined;
 }
 /**
- * 构件 `advanced.pdf-viewer`
+ * PDF 文件预览器，支持分页跳转和关键字高亮搜索
+ * @author developer
+ * @category display
  */
 export declare class PdfViewer extends ReactNextElement implements PdfViewerProps {
+    /** PDF 文件的访问地址 */
     accessor url: string;
+    /** 初始显示的页码（从 1 开始），内部会自动转换为从 0 开始的索引 */
     accessor page: number | undefined;
+    /** 文档加载后自动高亮的搜索关键字 */
     accessor search: string | undefined;
+    /** 查看器容器的内联样式，常用于设置高度（如 { height: "500px" }） */
     accessor viewerStyle: React.CSSProperties | undefined;
     render(): React.JSX.Element;
 }

package/dist-types/table/index.d.ts

@@ -292,13 +292,13 @@ declare class TableComponent extends ReactNextElement {
      */
     accessor pageSize: number | undefined;
     /**
+     * 表格是否可滚动，也可以指定滚动区域的宽、高，配置项。详见 [scroll](https://ant.design/components/table-cn/#scroll)
      * @kind {
      *   x?: string | number | true;
      *   y?: number | string;
      * } & {
      *   scrollToFirstRowOnChange?: boolean;
      * }
-     * 表格是否可滚动，也可以指定滚动区域的宽、高，配置项。详见 [scroll](https://ant.design/components/table-cn/#scroll)
      * @required false
      * @default { x: true }
      * @group other
@@ -400,6 +400,7 @@ declare class TableComponent extends ReactNextElement {
     private _isInSelect;
     /**
      * 搜索过滤
+     * @param event - 搜索事件，event.detail.q 为搜索关键词
      */
     filterSourceData(event: CustomEvent): void;
     handleFrontendDataChange(data?: Record<string, any>[], columns?: CustomColumn[]): Record<string, any>[];

package/dist-types/text-tooltip/index.d.ts

@@ -2,17 +2,18 @@ import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
 import "@next-core/theme";
 /**
- * 超出宽度鼠标悬浮显示tooltip
- * 构件 `eo-text-tooltip`
+ * 文本超出显示区域时，鼠标悬浮显示完整内容的 Tooltip
+ * @author developer
+ * @category display
  */
 export declare class EoTextTooltip extends ReactNextElement implements EoTextTooltipProps {
     /**
-     * 文案
+     * 显示的文本内容，超出时以省略号截断
      * @default
      */
     accessor label: string | undefined;
     /**
-     * 省略行数
+     * 省略的行数，超过该行数后显示省略号，设为 0 表示不省略
      * @default 1
      */
     accessor lineClamp: number;

package/dist-types/tree-select/index.d.ts

@@ -12,34 +12,74 @@ export interface TreeSelectProps extends Pick<AntdTreeSelectProps, "value" | "al
     maxTagCount?: number | "responsive";
     popupMatchSelectWidth?: boolean;
 }
+export interface TreeSelectEventsMap {
+    change: CustomEvent<{
+        value: AntdTreeSelectProps["value"];
+    }>;
+    search: CustomEvent<string>;
+    select: CustomEvent<{
+        value: AntdTreeSelectProps["value"];
+    }>;
+    expand: CustomEvent<{
+        keys: React.Key[];
+    }>;
+}
+export interface TreeSelectEventsMapping {
+    onChange: "change";
+    onSearch: "search";
+    onSelect: "select";
+    onExpand: "expand";
+}
 /**
- * 树选择器
+ * 树选择器，支持从树形数据中单选或多选节点
  * @author sailor
  * @category form-input-basic
  */
 export declare class TreeSelectBrick extends FormItemElementBase implements TreeSelectProps {
     #private;
+    /** 表单字段名 */
     accessor name: string | undefined;
+    /** 表单字段标签 */
     accessor label: string | undefined;
+    /** 是否为必填项 */
     accessor required: boolean | undefined;
+    /** 树形数据源 */
     accessor treeData: AntdTreeSelectProps["treeData"];
+    /** 是否默认展开所有树节点 */
     accessor treeDefaultExpandAll: boolean | undefined;
+    /** 受控展开的树节点 key 集合 */
     accessor treeExpandedKeys: string[] | undefined;
+    /** 自定义字段名，指定 label、value、children 对应的字段 */
     accessor fieldNames: AntdTreeSelectProps["fieldNames"];
+    /** 当前选中的值 */
     accessor value: AntdTreeSelectProps["value"];
+    /** 输入框占位文本 */
     accessor placeholder: string | undefined;
+    /** 是否支持多选 */
     accessor multiple: boolean | undefined;
+    /** 是否禁用 */
     accessor disabled: boolean | undefined;
+    /** 是否支持勾选树节点（开启后自动开启 multiple 模式） */
     accessor checkable: boolean | undefined;
+    /** 是否支持清除 */
     accessor allowClear: boolean | undefined;
+    /** 是否显示加载中状态 */
     accessor loading: boolean | undefined;
+    /** 自定义树节点过滤函数 */
     accessor filterTreeNode: AntdTreeSelectProps["filterTreeNode"];
+    /** 是否支持搜索，开启后可通过输入关键字过滤树节点 */
     accessor showSearch: boolean | undefined;
+    /** 自定义下拉箭头图标 */
     accessor suffixIcon: GeneralIconProps | undefined;
+    /** 浮层预设位置，可选 bottomLeft、bottomRight、topLeft、topRight */
     accessor popupPlacement: AntdTreeSelectProps["placement"];
+    /** 输入框大小，可选 large、middle、small */
     accessor size: AntdTreeSelectProps["size"];
+    /** 多选模式下最多显示的 tag 数量，设为 responsive 时会自适应宽度 */
     accessor maxTagCount: number | "responsive" | undefined;
+    /** 下拉框的样式 */
     accessor dropdownStyle: CSSProperties | undefined;
+    /** 下拉菜单的宽度是否与选择框相同 */
     accessor popupMatchSelectWidth: boolean | undefined;
     handleOnChange: (value: AntdTreeSelectProps["value"]) => void;
     render(): React.JSX.Element;