@aimerthyr/virtual-table 1.4.0 → 1.4.2

package/dist/index.d.ts

@@ -69,7 +69,12 @@ export declare interface VTableBodyCellProps<TData = any> {
     column: VTableColumn;
     row: TData;
     rowIndex: number;
-    isEditing: boolean;
+    /** 编辑模式
+     * row  => 整行编辑
+     * cell => 单元格编辑
+     * null => 未处于编辑态
+     *  */
+    isEditingMode: 'row' | 'cell' | null;
 }
 
 /** 表体样式配置 */
@@ -144,6 +149,8 @@ export declare interface VTableColumn<TData = any> {
     columnMinWidth?: number;
     /** 子列（用于表头分组） */
     columnChildren?: VTableColumn<TData>[];
+    /** 汇总计算方式 (sum 汇总 agv 平均值 count 统计 max 最大值 min 最小值) */
+    columnSummary?: VTableSummaryType<TData>;
 }
 
 /** 筛选状态 */
@@ -176,6 +183,7 @@ export declare const vTableDefaultProps: {
     loadMoreConfig?: ((props: VTableProps<any>) => VTableLoadMoreConfig) | undefined;
     paginationConfig?: ((props: VTableProps<any>) => VTablePaginationConfig) | undefined;
     treeConfig?: ((props: VTableProps<any>) => VTableTreeConfig) | undefined;
+    summaryConfig?: ((props: VTableProps<any>) => VTableSummaryConfig<any>) | undefined;
     enableExpandRow?: boolean | ((props: VTableProps<any>) => boolean) | undefined;
     enableRowHover?: boolean | ((props: VTableProps<any>) => boolean) | undefined;
     adaptiveColumnWidth?: number | ((props: VTableProps<any>) => number) | undefined;
@@ -241,8 +249,12 @@ export declare interface VTableInstance<TData = any> {
     tanstackTable: Table<TData>;
     /** 滚动到指定下标(从 0 开始，默认是平滑滚动) */
     scrollToIndex: (index: number, behavior?: 'auto' | 'smooth') => void;
-    /** 设置当前编辑行 (传 null 代表退出编辑态) */
-    setEditingRow: (rowId: string | number | null) => void;
+    /** 设置编辑状态
+     * 1. columnKey 为空，则为行编辑
+     * 2. columnKey 不为空，则为单元格编辑
+     * 3. rowId 传 null，清除编辑状态
+     */
+    setEditingState: (rowId: string | number | null, columnKey?: string | null) => void;
 }
 
 export declare interface VTableLoadMoreConfig {
@@ -266,6 +278,14 @@ export declare interface VTablePaginationConfig {
 }
 
 export declare interface VTablePaginationExtraProps {
+    /** 是否显示总计 */
+    showTotal?: boolean;
+    /** 是否显示每页条数选择器 */
+    showSizeChanger?: boolean;
+    /** 总计文本 */
+    totalText?: string;
+    /** 每页条数选择器文本 */
+    pageSizeText?: string;
 }
 
 /**
@@ -325,6 +345,8 @@ export declare interface VTableProps<TData = any> {
     paginationConfig?: VTablePaginationConfig;
     /** 树形结构配置 */
     treeConfig?: VTableTreeConfig;
+    /** 汇总行配置 */
+    summaryConfig?: VTableSummaryConfig<TData>;
     /** 是否启用展开行功能 */
     enableExpandRow?: boolean;
     /** 是否启用行 hover 高亮 */
@@ -451,6 +473,12 @@ export declare interface VTableSlots<TData = any> {
     customExpandIcon?: (props: VTableExpandIconProps) => VNode_2[];
     /** 自定义排序图标 */
     customSorterIcon?: (props: VTableSorterIconProps) => VNode_2[];
+    /** 自定义汇总单元格 */
+    summaryCell?: (props: {
+        columnKey: string;
+        column: VTableColumn;
+        summaryValue: any;
+    }) => VNode_2[];
     [key: string]: ((...args: any[]) => VNode_2[]) | undefined;
 }
 
@@ -462,6 +490,21 @@ export declare interface VTableSorterIconProps {
 /** 排序状态 */
 export declare type VTableSortingState = SortingState;
 
+/** 汇总配置 */
+export declare interface VTableSummaryConfig<TData = any> {
+    /** 是否显示汇总行 */
+    enabled?: boolean;
+    /** 汇总行固定（不随表格滚动） */
+    fixed?: boolean;
+    /** 自定义汇总计算函数（优先级高于列配置） */
+    customSummary?: (column: VTableColumn, data: TData[]) => any;
+}
+
+export declare type VTableSummaryFn<TData = any> = (data: TData[], column: VTableColumn) => any;
+
+/** 汇总类型 */
+export declare type VTableSummaryType<TData> = 'sum' | 'avg' | 'count' | 'max' | 'min' | VTableSummaryFn<TData>;
+
 /** 表格主题配置 */
 export declare interface VTableThemeConfig {
     /** 主色 */