ele-admin-plus 1.1.4 → 1.1.5-beta.2

package/es/ele-virtual-table/types/index.d.ts

@@ -0,0 +1,157 @@
+import type { VNode } from 'vue';
+import type { Column as TableV2Column, ExtractRowPropGetter, RowExpandHandler, SortBy, HeaderClassNameGetter, ExtractHeaderPropGetter } from 'element-plus/es/components/table-v2';
+import type { ScrollStrategy, ScrollPos } from 'element-plus/es/components/table-v2/src/composables/use-scrollbar';
+import type { ElTableV2Props } from '../../ele-app/types';
+import type { DataKey, DataItem, Column, FilterValue } from '../../ele-data-table/types';
+export { RowExpandHandler, ScrollStrategy, SortBy, ScrollPos };
+/**
+ * 列配置
+ */
+export type VirtualColumn = Partial<TableV2Column<DataItem>>;
+/**
+ * 表格列配置
+ */
+export type VirtualColumns = VirtualColumn[];
+/**
+ * 主体列配置
+ */
+export interface BodyColumn {
+    /** 唯一值 */
+    key: string;
+    /** 数据值字段名 */
+    dataKey?: string;
+    /** 指定的宽度 */
+    width?: number;
+    /** 最小宽度 */
+    minWidth: number;
+    /** 是否是最后一个左侧固定列 */
+    isFixedLeftLast?: boolean;
+    /** 是否是第一个右侧固定列 */
+    isFixedRightFirst?: boolean;
+    /** 原始列配置 */
+    originalCol?: Column;
+}
+/**
+ * 主体行的列配置
+ */
+export type BodyColumns = BodyColumn[];
+/**
+ * 表头列配置
+ */
+export interface HeaderColumn {
+    /** 唯一值 */
+    key?: string;
+    /** 所占列数 */
+    colspan?: number;
+    /** 所占行数 */
+    rowspan?: number;
+    /** 是否是最后一个左侧固定列 */
+    isFixedLeftLast?: boolean;
+    /** 是否是第一个右侧固定列 */
+    isFixedRightFirst?: boolean;
+    /** 原始的列配置 */
+    originalCol?: Column;
+}
+/**
+ * 表头行的列配置
+ */
+export type HeaderColumns = HeaderColumn[];
+/**
+ * 表头行的数据
+ */
+export type HeaderRows = HeaderColumns[];
+/**
+ * 表格属性
+ */
+export type TableV2Props = Required<Exclude<ElTableV2Props, 'class' | 'style'>>;
+/**
+ * 获取行类名方法
+ */
+export type RowClassFunction = ExtractRowPropGetter<DataItem>;
+/**
+ * 获取行属性方法
+ */
+export type RowPropsFunction = ExtractRowPropGetter<DataItem>;
+/**
+ * 获取表头行类名方法
+ */
+export type HeaderRowClassFunction = HeaderClassNameGetter<DataItem>;
+/**
+ * 获取表头行属性方法
+ */
+export type HeaderRowPropsFunction = ExtractHeaderPropGetter<DataItem>;
+/**
+ * 表格状态
+ */
+export interface TableState {
+    /** 单选选中行数据 */
+    current?: DataItem | null;
+    /** 多选选中行数据 */
+    selected: Map<DataKey, DataItem>;
+    /** 表格垂直滚动位置 */
+    scrollTop: number;
+}
+/**
+ * 表头列筛选改变事件参数
+ */
+export interface CellFilterChangeParams {
+    /** 列配置 */
+    column: Column;
+    /** 筛选值 */
+    value: FilterValue;
+}
+/**
+ * 合并单元格
+ */
+export interface CellSpan {
+    /** 所占列数 */
+    colspan?: number;
+    /** 所占行数 */
+    rowspan?: number;
+}
+/**
+ * 自定义渲染组件属性
+ */
+export interface CustomRenderProps {
+    /** 自定义渲染方法 */
+    render?: (...params: any) => string | VNode | VNode[] | undefined;
+    /** 自定义渲染参数 */
+    params?: Array<any>;
+}
+/**
+ * 嵌套数据配置项
+ */
+export interface TreeTableProps {
+    /** 子级字段名 */
+    childrenName: string;
+    /** 懒加载标识是否有子级字段名 */
+    hasChildrenName: string;
+}
+/**
+ * 列尺寸
+ */
+export interface ColSize {
+    /** 列宽 */
+    width: number;
+    /** 左侧固定列位置 */
+    fixedLeft?: string;
+    /** 右侧固定列位置 */
+    fixedRight?: string;
+}
+/**
+ * 合计行列
+ */
+export interface SumCol extends ColSize {
+    /** 唯一值 */
+    key: string;
+    /** 显示文本 */
+    text?: string;
+    /** 对齐方式 */
+    align?: string;
+    /** 固定列 */
+    fixed?: string | boolean;
+    /** 是否是最后一个左侧固定列 */
+    isFixedLeftLast?: boolean;
+    /** 是否是第一个右侧固定列 */
+    isFixedRightFirst?: boolean;
+}

package/es/ele-virtual-table/util.d.ts

@@ -0,0 +1,200 @@
+import type { SetupContext } from 'vue';
+import { TableV2SortOrder } from 'element-plus';
+import type { DataKey, DataItem, Column, Columns, Sorter, Filter, FilterValue, OrderValue, TableSize, RowKey, RowSelectable, TreeProps, ShowOverflowTooltip } from '../ele-data-table/types';
+import type { VirtualColumn, VirtualColumns, BodyColumns, HeaderColumn, HeaderRows, ColSize, CustomRenderProps, SortBy, TreeTableProps } from './types';
+/**
+ * 获取行高
+ * @param size 表格尺寸
+ * @param rowHeight 自定义行高
+ */
+export declare function getRowHeight(size?: TableSize, rowHeight?: number): number;
+/**
+ * 获取列的唯一值
+ * @param column 列配置
+ */
+export declare function getColKey(column?: Column): string;
+/**
+ * 获取数字类型的尺寸
+ * @param size 字符或数字类型的尺寸
+ * @param defaultValue 默认值
+ */
+export declare function getNumberSize<T extends number | undefined>(size?: string | number, defaultValue?: T): number | T;
+/**
+ * 获取表格高度
+ * @param height 自定义高度
+ * @param maxHeight 最大高度
+ * @param minHeight 最小高度
+ * @param wrapHeight 容器高度
+ */
+export declare function getTableHeight(height: string | number | undefined, maxHeight: string | number | undefined, minHeight: number, wrapHeight: number): number;
+/**
+ * 计算固定列需要显示阴影的位置
+ * @param cols 列配置
+ */
+export declare function computeFixedCols(cols: VirtualColumns): void;
+/**
+ * 生成表头和主体列配置
+ * @param columns 列配置
+ * @param cols 用于存放主体列
+ * @param rows 用于存放表头列
+ * @param level 多级表头时当前级别
+ * @param parentRowCol 多级表头时父表头列
+ */
+export declare function generateRowCols(columns: Columns, cols: BodyColumns, rows: HeaderRows, level: number, parentRowCol?: HeaderColumn): void;
+/**
+ * 分析列配置
+ * @param columns 列配置
+ */
+export declare function analyseColumns(columns: Columns | undefined): {
+    cols: BodyColumns;
+    rows: HeaderRows;
+};
+/**
+ * 分配列宽
+ * @param col 列属性
+ * @param tableWidth 表格宽度
+ * @param colsWidth 已知的列总计宽度
+ * @param colsMinWidth 剩余列总计最小宽度
+ */
+export declare function getColWidth(col: VirtualColumn, tableWidth: number, colsWidth: number, colsMinWidth: number): number;
+/**
+ * 计算左右固定列浮动位置
+ * @param cols 列配置
+ * @param colSizes 全部列宽
+ */
+export declare function computeFixedPositions(cols: VirtualColumns, colSizes: ColSize[]): void;
+/**
+ * 计算列宽和固定列浮动位置
+ * @param cols 主体列
+ * @param rows 表头行
+ * @param wrapWidth 容器宽度
+ */
+export declare function computeColSizes(cols: VirtualColumns, rows: HeaderRows, wrapWidth: number): {
+    width: number;
+    colSizes: ColSize[];
+    rowSizes: ColSize[][];
+    sumWidth: number;
+};
+/**
+ * 判断表格列尺寸是否改变
+ * @param colSizes 当前所有列尺寸
+ * @param newSizes 新的所有列尺寸
+ */
+export declare function colSizesIsChanged(colSizes: ColSize[], newSizes: ColSize[]): boolean;
+/**
+ * 生成 ElTableV2 格式的列配置
+ * @param bodyCols 主体列配置
+ * @param colSizes 列尺寸数据
+ */
+export declare function getTableColumns(bodyCols: BodyColumns, colSizes: ColSize[]): Partial<import("element-plus").Column<DataItem>>[];
+/**
+ * 处理表格数据
+ * @param data 数据
+ * @param hasExpandCol 是否有展开列
+ * @param childrenName 树表格子级数据字段名
+ * @param rowKey 数据唯一值字段名
+ * @param selectable 控制行是否可选中的方法
+ */
+export declare function transformTableData(data: DataItem[] | undefined, hasExpandCol: boolean, childrenName: string, rowKey: RowKey, selectable?: RowSelectable | null): DataItem[];
+/**
+ * 判断是否自适应行高
+ * @param hasExpandCol 是否有展开行
+ * @param bodyCols 主体列配置
+ * @param showOverflowTooltip 全局溢出提示属性
+ */
+export declare function isAutoRowHeight(hasExpandCol: boolean, bodyCols: BodyColumns, showOverflowTooltip: ShowOverflowTooltip): boolean;
+/**
+ * 单元格渲染组件(用于同时支持插槽和返回 VNode 的自定义渲染函数)
+ * @param props 属性
+ * @param ctx SetupContext
+ */
+export declare function CellRender(props: CustomRenderProps, ctx: SetupContext): (string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>)[] | undefined;
+/**
+ * 获取表头点击后的排序值
+ * @param current 当前排序值
+ * @param col 点击的列
+ */
+export declare function getSortBy(current?: SortBy, col?: Column): SortBy | undefined;
+/**
+ * 获取排序值对应的枚举
+ * @param order 排序值
+ */
+export declare function getSortOrder(order?: OrderValue): TableV2SortOrder | undefined;
+/**
+ * 获取排序枚举对应的值
+ * @param sort 排序枚举
+ */
+export declare function getOrderValue(sort?: TableV2SortOrder): OrderValue | undefined;
+/**
+ * 获取默认排序
+ * @param defaultSort 默认排序值
+ */
+export declare function getDefaultSort(defaultSort?: Sorter): SortBy | undefined;
+/**
+ * 获取默认筛选
+ * @param columns 列配置
+ */
+export declare function getDefaultFiltered(columns?: Columns): Filter;
+/**
+ * 获取列筛选值
+ * @param col 列配置
+ * @param filtered 当前筛选值
+ */
+export declare function getColFiltered(col?: Column, filtered?: Filter): FilterValue;
+/**
+ * 获取判断多选是否可选择的方法
+ * @param cols 列配置
+ */
+export declare function getSelectableFunc(cols: BodyColumns): ((row: any, index: number) => boolean) | null | undefined;
+/**
+ * 获取嵌套数据配置项
+ * @param treeProps 嵌套数据配置项
+ */
+export declare function getTreeProps(treeProps?: TreeProps): TreeTableProps;
+/**
+ * 计算列合计值
+ * @param data 表格数据
+ * @param prop 列字段名称
+ */
+export declare function getSumValue(data?: DataItem[], prop?: string): string;
+/**
+ * 获取原始列配置
+ * @param columns 列配置
+ * @param key 列的 key
+ * @param dataKey 列的 dataKey
+ */
+export declare function getColumnByKey(columns?: Columns, key?: string, dataKey?: string): Column | undefined;
+/**
+ * 尺寸取整
+ * @param size 尺寸
+ */
+export declare function floorSize(size: number): number;
+/**
+ * 判断单元格是否溢出
+ * @param cell 单元格节点
+ */
+export declare function cellIsOverflow(cell: HTMLElement): boolean;
+/**
+ * 表格自适应容器宽高
+ * @param getEl 获取根节点的方法
+ */
+export declare function useAutoResize(getEl: () => HTMLElement | null): {
+    wrapWidth: import("vue").Ref<number>;
+    wrapHeight: import("vue").Ref<number>;
+    updateWrapSize: () => void;
+};
+/**
+ * 表格状态数据管理
+ */
+export declare function useState(): {
+    getCurrent: () => DataItem | null | undefined;
+    setCurrent: (row?: DataItem | null) => void;
+    getSelected: () => DataItem[];
+    addSelected: (key: DataKey, row: DataItem) => void;
+    removeSelected: (key: DataKey) => void;
+    clearSelected: () => void;
+    getScrollTop: () => number;
+    cacheScrollTop: (top: number) => void;
+};