@next-bricks/advanced 0.51.2 → 0.51.4

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

@@ -17,11 +17,12 @@ export interface CascaderProps extends Pick<AntdCascaderProps, "options" | "fiel
     maxTagCount?: number | "responsive";
     onChange?: (value: AntdCascaderProps["value"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][]) => void;
 }
+export interface CascaderChangeEventDetail {
+    value: AntdCascaderProps["value"];
+    selectedOptions: DefaultOptionType[] | DefaultOptionType[][];
+}
 export interface CascaderEventsMap {
-    pageChange: CustomEvent<{
-        value: AntdCascaderProps["value"];
-        selectedOptions: DefaultOptionType[] | DefaultOptionType[][];
-    }>;
+    "cascader.change": CustomEvent<CascaderChangeEventDetail>;
 }
 export interface CascaderEventsMapping {
     onCascaderChange: "cascader.change";
@@ -33,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

@@ -2,37 +2,50 @@ import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
 import "@next-core/theme";
 import type { CellConfig, Column, DataSource, ExpandableType, NextTableProps, PaginationType, RecordType, RowSelectionType, Sort, TableScroll } from "./interface.js";
+import { RowSelectMethod } from "antd/es/table/interface.js";
 import type { TableProps } from "antd/es/table";
 import "./host-context.css";
-export interface NextTableEventsMap {
-    pageChange: CustomEvent<Record<string, number>>;
-    filterUpdate: CustomEvent<Record<string, number>>;
-    selectUpdate: CustomEvent<Record<string, any>[]>;
-    selectRowKeysUpdate: CustomEvent<string[]>;
-    sortUpdate: CustomEvent<{
-        sort: string;
-        order: string | number;
-    }>;
-    rowExpand: CustomEvent<{
-        expanded: boolean;
-        record: Record<string, any>;
-    }>;
-    expandRowsChange: CustomEvent<{
-        expandedRows: React.Key[];
-    }>;
-    rowDrag: CustomEvent<{
-        data: Record<string, any>[];
-    }>;
+export interface PageOrPageSizeChangeEventDetail {
+    page: number;
+    pageSize: number;
 }
-export interface NextTableEventsMapping {
-    onPageChange: "page.update";
-    onfilterUpdate: "filter.update";
-    selectUpdate: "select.update";
-    selectRowKeysUpdate: "select.row.keys.update";
-    sortUpdate: "sort.update";
-    rowExpand: "row.expand";
-    expandRowsChange: "expand.rows.change";
-    rowDrag: "row.drag";
+export interface RowSelectEventDetail {
+    keys: (string | number)[];
+    rows: RecordType[];
+    info: {
+        type: RowSelectMethod;
+    };
+}
+export interface RowExpandEventDetail {
+    expanded: boolean;
+    record: RecordType;
+}
+export interface RowDragEventDetail {
+    list: RecordType[];
+    active: RecordType;
+    over: RecordType;
+}
+export interface EoNextTableEventsMap {
+    "page.change": CustomEvent<PageOrPageSizeChangeEventDetail>;
+    "page.size.change": CustomEvent<PageOrPageSizeChangeEventDetail>;
+    "sort.change": CustomEvent<Sort | Sort[] | undefined>;
+    "row.click": CustomEvent<RecordType>;
+    "row.select": CustomEvent<RowSelectEventDetail>;
+    "row.select.v2": CustomEvent<RecordType[]>;
+    "row.expand": CustomEvent<RowExpandEventDetail>;
+    "expanded.rows.change": CustomEvent<(string | number)[]>;
+    "row.drag": CustomEvent<RowDragEventDetail>;
+}
+export interface EoNextTableEventsMapping {
+    onPageChange: "page.change";
+    onPageSizeChange: "page.size.change";
+    onSortChange: "sort.change";
+    onRowClick: "row.click";
+    onRowSelect: "row.select";
+    onRowSelectV2: "row.select.v2";
+    onRowExpand: "row.expand";
+    onExpandedRowsChange: "expanded.rows.change";
+    onRowDrag: "row.drag";
 }
 /**
  * 大型表格
@@ -50,7 +63,7 @@ export declare class EoNextTable extends ReactNextElement implements NextTablePr
      */
     accessor columns: Column[] | undefined;
     /**
-     * 单元格
+     * 单元格统一配置，可配置 useBrick 自定义渲染所有单元格及表头
      */
     accessor cell: CellConfig | undefined;
     /**
@@ -143,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

@@ -75,35 +75,39 @@ export interface CustomColumn extends ColumnProps<Record<string, any>> {
         useBrick: UseSingleBrickConf;
     };
 }
+export interface SortUpdateEventDetail {
+    sort: string;
+    order: string | number;
+}
+export interface RowExpandEventDetail {
+    expanded: boolean;
+    record: Record<string, any>;
+}
+export interface ExpandRowsChangeEventDetail {
+    expandedRows: React.Key[];
+}
+export interface RowDragEventDetail {
+    data: Record<string, any>[];
+}
 export interface EoTableEventsMap {
-    pageChange: CustomEvent<Record<string, number>>;
-    filterUpdate: CustomEvent<Record<string, number>>;
-    selectUpdate: CustomEvent<Record<string, any>[]>;
-    selectRowKeysUpdate: CustomEvent<string[]>;
-    sortUpdate: CustomEvent<{
-        sort: string;
-        order: string | number;
-    }>;
-    rowExpand: CustomEvent<{
-        expanded: boolean;
-        record: Record<string, any>;
-    }>;
-    expandRowsChange: CustomEvent<{
-        expandedRows: React.Key[];
-    }>;
-    rowDrag: CustomEvent<{
-        data: Record<string, any>[];
-    }>;
+    "page.update": CustomEvent<Record<string, number>>;
+    "filter.update": CustomEvent<Record<string, number>>;
+    "select.update": CustomEvent<Record<string, any>[]>;
+    "select.row.keys.update": CustomEvent<string[]>;
+    "sort.update": CustomEvent<SortUpdateEventDetail>;
+    "row.expand": CustomEvent<RowExpandEventDetail>;
+    "expand.rows.change": CustomEvent<ExpandRowsChangeEventDetail>;
+    "row.drag": CustomEvent<RowDragEventDetail>;
 }
 export interface EoTableEventsMapping {
     onPageChange: "page.update";
-    onfilterUpdate: "filter.update";
-    selectUpdate: "select.update";
-    selectRowKeysUpdate: "select.row.keys.update";
-    sortUpdate: "sort.update";
-    rowExpand: "row.expand";
-    expandRowsChange: "expand.rows.change";
-    rowDrag: "row.drag";
+    onFilterUpdate: "filter.update";
+    onSelectUpdate: "select.update";
+    onSelectRowKeysUpdate: "select.row.keys.update";
+    onSortUpdate: "sort.update";
+    onRowExpand: "row.expand";
+    onExpandRowsChange: "expand.rows.change";
+    onRowDrag: "row.drag";
 }
 /**
  * 简易表格构件。
@@ -288,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
@@ -396,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/index.d.ts

@@ -48,6 +48,18 @@ export interface DropDetail {
     dropPosition: number;
 }
 export type RawDropInfo = Parameters<Exclude<TreeProps<TreeNode>["onDrop"], undefined>>[0];
+export interface EoTreeEventsMap {
+    check: CustomEvent<TreeNodeKey[]>;
+    "check.detail": CustomEvent<CheckDetail>;
+    expand: CustomEvent<TreeNodeKey[]>;
+    "node.drop": CustomEvent<DropDetail>;
+}
+export interface EoTreeEventsMapping {
+    onCheck: "check";
+    onCheckDetail: "check.detail";
+    onExpand: "expand";
+    onNodeDrop: "node.drop";
+}
 /**
  * 树形构件
  * @author steve

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;

package/dist-types/workbench-layout/index.d.ts

@@ -27,16 +27,41 @@ export interface EoWorkbenchLayoutComponentProps extends EoWorkbenchLayoutProps
     onActionClick?: (action: SimpleAction, layouts: Layout[]) => void;
 }
 export declare const EoWorkbenchLayoutComponent: React.ForwardRefExoticComponent<EoWorkbenchLayoutComponentProps & React.RefAttributes<EoWorkbenchLayoutComponentRef>>;
+export interface EoWorkbenchLayoutEventsMap {
+    change: CustomEvent<Layout[]>;
+    save: CustomEvent<Layout[]>;
+    cancel: CustomEvent<void>;
+    "action.click": CustomEvent<{
+        action: SimpleAction;
+        layouts: Layout[];
+    }>;
+}
+export interface EoWorkbenchLayoutEventsMapping {
+    onChange: "change";
+    onSave: "save";
+    onCancel: "cancel";
+    onActionClick: "action.click";
+}
 /**
- * 工作台布局
+ * 工作台布局（拖拽式卡片布局，支持编辑模式）
  * @deprecated Please use eo-workbench-layout-v2 which support global styles instead
+ * @author developer
+ * @category layout
  */
 export declare class EoWorkbenchLayout extends ReactNextElement {
     #private;
+    /** 编辑模式下左侧卡片列表面板的标题 */
     accessor cardTitle: string | undefined;
+    /** 是否进入编辑模式，编辑模式下可拖拽调整布局并显示卡片选择面板 */
     accessor isEdit: boolean | undefined;
+    /** 当前布局配置，每项对应一个卡片的位置与大小 */
     accessor layouts: Layout[] | undefined;
+    /** 组件列表，每项包含 key、title、useBrick 和 position 信息 */
     accessor componentList: Item[] | undefined;
+    /**
+     * 设置布局配置
+     * @param layouts - 新的布局配置数组
+     */
     setLayouts(layouts: Layout[]): void;
     render(): React.JSX.Element;
 }

package/dist-types/workbench-layout-v2/index.d.ts

@@ -29,30 +29,52 @@ export interface EoWorkbenchLayoutV2ComponentProps extends EoWorkbenchLayoutV2Pr
     onSetting?: () => void;
 }
 export declare const EoWorkbenchLayoutComponent: React.ForwardRefExoticComponent<EoWorkbenchLayoutV2ComponentProps & React.RefAttributes<EoWorkbenchLayoutV2ComponentRef>>;
+export interface EoWorkbenchLayoutV2EventsMap {
+    change: CustomEvent<ExtraLayout[]>;
+    save: CustomEvent<ExtraLayout[]>;
+    cancel: CustomEvent<void>;
+    setting: CustomEvent<void>;
+    "action.click": CustomEvent<{
+        action: SimpleAction;
+        layouts: ExtraLayout[];
+    }>;
+}
+export interface EoWorkbenchLayoutV2EventsMapping {
+    onChange: "change";
+    onSave: "save";
+    onCancel: "cancel";
+    onSetting: "setting";
+    onActionClick: "action.click";
+}
 /**
- * 工作台布局V2, 未使用shadow dom
+ * 工作台布局 V2，支持拖拽式卡片布局与全局样式（不使用 shadow DOM）
+ * @author developer
+ * @category layout
  */
 export declare class EoWorkbenchLayoutV2 extends ReactNextElement {
     #private;
+    /** 编辑模式下左侧卡片列表面板的标题 */
     accessor cardTitle: string | undefined;
+    /** 是否进入编辑模式，编辑模式下可拖拽调整布局并显示卡片选择面板 */
     accessor isEdit: boolean | undefined;
+    /** 当前布局配置，每项对应一个卡片的位置与大小及样式信息 */
     accessor layouts: ExtraLayout[] | undefined;
+    /** 编辑模式下工具栏区域的自定义构件 */
     accessor toolbarBricks: {
         useBrick: UseSingleBrickConf[];
     } | undefined;
+    /** 组件列表，每项包含 key、title、useBrick 和 position 信息 */
     accessor componentList: WorkbenchComponent[] | undefined;
-    /**
-     * 自定义卡片默认配置, 用于覆盖默认卡片配置
-     */
+    /** 自定义卡片默认配置，用于覆盖默认卡片样式配置 */
     accessor customDefaultCardConfigMap: Record<string, CardStyleConfig> | undefined;
-    /**
-     * description: 用于设置页面样式和布局的按钮
-     */
+    /** 是否显示设置按钮，用于触发页面样式和布局设置 */
     accessor showSettingButton: boolean | undefined;
+    /** 卡片之间的间距（px） */
+    accessor gap: number | undefined;
     /**
-     * description: 卡片间隔
+     * 设置布局配置
+     * @param layouts - 新的布局配置数组
      */
-    accessor gap: number | undefined;
     setLayouts(layouts: Layout[]): void;
     connectedCallback(): void;
     render(): React.JSX.Element;