bkui-vue 0.0.2-beta.8 → 0.0.2-table-refactor.1

package/lib/table/plugins/use-fixed-column.d.ts

@@ -1,22 +1,24 @@
-import { GroupColumn } from '../props';
+import { Column, TablePropTypes } from '../props';
+import { ITableResponse } from '../use-attributes';
 /**
  * 固定列Hooks
  */
-declare const _default: (_props: any, colgroups: GroupColumn[], hasScrollY?: any) => {
+declare const _default: (props: TablePropTypes, tableResp: ITableResponse, hasScrollY?: any) => {
     fixedWrapperClass: string;
-    resolveFixedColumnStyle: (column: GroupColumn, hasScrollY?: boolean) => {
+    resolveFixedColumnStyle: (column: Column, hasScrollY?: boolean) => {
         [x: string]: string;
     };
     fixedColumns: import("vue").ComputedRef<{
         isExist: boolean;
         colPos: string;
-        column: GroupColumn;
+        column: Column;
     }[]>;
     resolveColumnStyle: (colPos: string) => {
         width: string;
+        backgroundColor: string;
         bottom: string;
     };
-    resolveColumnClass: (column: GroupColumn, scrollX?: any, offsetRight?: any) => {
+    resolveColumnClass: (column: Column, scrollX?: any, offsetRight?: any) => {
         column_fixed: boolean;
         column_fixed_left: boolean;
         column_fixed_right: boolean;

package/lib/table/plugins/use-pagination.d.ts

@@ -1,4 +1,4 @@
-import { TablePropTypes } from '../props';
+import { Column, SortScope, TablePropTypes } from '../props';
 /**
  * 处理 Prop中的分页配置
  * prop中的配置会覆盖本地的配置
@@ -7,10 +7,13 @@ import { TablePropTypes } from '../props';
  * @returns 返回值
  */
 export declare const resolvePaginationOption: (propPagination: any, defVal: any) => any;
-declare const _default: (props: TablePropTypes, indexData: any[]) => {
+declare const _default: (props: TablePropTypes) => {
     pageData: any[];
+    indexData: import("vue").ComputedRef<any[]>;
     localPagination: any;
-    resolvePageData: (filterFn: any, sortFn: any, activeSortColumn: any) => void;
-    watchEffectFn: (filterFn: any, sortFn: any, activeSortColumn: any) => void;
+    resolvePageData: (filterFn?: any, sortFn?: any, column?: Column, type?: string, sortScope?: any) => void;
+    resetStartEndIndex: () => void;
+    multiFilter: (filterFnList: ((row: any, index: any, data: any) => void)[]) => void;
+    sort: (sourceData: any[], sortFn: any, column: Column, type: string, sortScope: SortScope) => void;
 };
 export default _default;

package/lib/table/props.d.ts

@@ -1,5 +1,5 @@
-import { ExtractPropTypes, Slot } from 'vue';
-import { ROW_HOVER, SORT_OPTION } from './const';
+import { ExtractPropTypes } from 'vue';
+import { IHeadColor, ROW_HOVER, SORT_OPTION } from './const';
 export declare enum SortScope {
     CURRENT = "current",
     ALL = "all"
@@ -12,7 +12,7 @@ export declare enum OverflowModeEnum {
     STATIC = "static",
     AUTO = "auto"
 }
-export declare const overflowModeType: import("vue-types").VueTypeDef<"auto" | "static">;
+export declare const EnumOverflowModeType: import("vue-types").VueTypeDef<"auto" | "static">;
 export declare enum ColumnTypeEnum {
     SELECTION = "selection",
     INDEX = "index",
@@ -43,15 +43,38 @@ export declare enum FixedEnum {
     RIGHT = "right"
 }
 export declare const fixedType: import("vue-types").VueTypeValidableDef<"right" | "left">;
-export type IOverflowTooltip = {
+export type IOverflowTooltipProp = {
     content: string | Function;
-    disabled?: boolean;
+    disabled?: (col: Column, row: any) => boolean | boolean;
     watchCellResize?: boolean;
     mode?: `${OverflowModeEnum}`;
-};
+    popoverOption?: any;
+    resizerWay?: ResizerWay;
+} | boolean;
+export type IOverflowTooltip = IOverflowTooltipProp;
+export declare const IOverflowTooltipPropType: import("vue-types").VueTypeDef<IOverflowTooltipProp>;
 export type ISortOption = {
     [key: string]: SORT_OPTION;
 };
+export declare const ISortType: import("vue-types").VueTypeDef<ISortPropShape>;
+export type ISortShape = {
+    sortFn?: Function;
+    sortScope?: SortScope;
+    value?: SORT_OPTION;
+};
+export type ISortPropShape = ISortShape | boolean | string;
+export type IFilterShape = {
+    list: any[];
+    filterFn?: Function;
+    match?: FullEnum;
+    checked?: any[];
+    filterScope?: SortScope;
+    btnSave?: boolean | string;
+    btnReset?: boolean | string;
+    maxHeight?: number;
+};
+export type IFilterPropShape = IFilterShape | boolean | string;
+export declare const IFilterType: import("vue-types").VueTypeDef<IFilterPropShape>;
 export declare enum ColumnPickEnum {
     MULTI = "multi",
     SINGLE = "single",
@@ -61,67 +84,137 @@ export declare enum ResizerWay {
     DEBOUNCE = "debounce",
     THROTTLE = "throttle"
 }
-export declare const IColumnType: {
-    label: import("vue-types").VueTypeDef<any>;
-    field: import("vue-types").VueTypeDef<any>;
-    render: import("vue-types").VueTypeDef<any>;
-    width: import("vue-types").VueTypeDef<string | number>;
-    minWidth: import("vue-types").VueTypeDef<string | number> & {
-        default: string | number;
-    };
-    columnKey: import("vue-types").VueTypeValidableDef<string> & {
-        default: string;
-    } & {
-        default: string;
-    };
-    showOverflowTooltip: import("vue-types").VueTypeDef<boolean | IOverflowTooltip> & {
-        default: boolean | (() => IOverflowTooltip);
-    };
-    type: import("vue-types").VueTypeDef<"none" | "selection" | "index" | "expand">;
-    resizable: import("vue-types").VueTypeValidableDef<boolean> & {
-        default: boolean;
-    } & {
-        default: boolean;
-    };
-    fixed: import("vue-types").VueTypeDef<boolean | "right" | "left"> & {
-        default: boolean | "right" | "left";
-    };
-    sort: import("vue-types").VueTypeDef<string | boolean | {
-        sortFn: any;
-        sortScope: (object | "all" | "current" | (() => "all" | "current") | ((props: Record<string, unknown>) => "all" | "current")) & ("all" | "current");
-        value: string;
-    }> & {
-        default: string | boolean | (() => {
-            sortFn: any;
-            sortScope: (object | "all" | "current" | (() => "all" | "current") | ((props: Record<string, unknown>) => "all" | "current")) & ("all" | "current");
-            value: string;
-        });
-    };
-    filter: import("vue-types").VueTypeDef<string | boolean | {
-        list: any[] | (object & (() => any[]));
-        filterFn: any;
-        match: "full" | "fuzzy";
-        checked: any[] | (object & (() => any[]));
-        filterScope: (object | "all" | "current" | (() => "all" | "current") | ((props: Record<string, unknown>) => "all" | "current")) & ("all" | "current");
-        btnSave: (string | boolean | object | (() => string | boolean) | ((props: Record<string, unknown>) => string | boolean)) & (string | boolean);
-        btnReset: (string | boolean | object | (() => string | boolean) | ((props: Record<string, unknown>) => string | boolean)) & (string | boolean);
-    }> & {
-        default: string | boolean | (() => {
-            list: any[] | (object & (() => any[]));
-            filterFn: any;
-            match: "full" | "fuzzy";
-            checked: any[] | (object & (() => any[]));
-            filterScope: (object | "all" | "current" | (() => "all" | "current") | ((props: Record<string, unknown>) => "all" | "current")) & ("all" | "current");
-            btnSave: (string | boolean | object | (() => string | boolean) | ((props: Record<string, unknown>) => string | boolean)) & (string | boolean);
-            btnReset: (string | boolean | object | (() => string | boolean) | ((props: Record<string, unknown>) => string | boolean)) & (string | boolean);
-        });
+export declare const IColumnType: import("vue-types").VueTypeDef<Column>;
+export declare const ITableSettings: import("vue-types").VueTypeDef<ISettingPropType>;
+/**
+ * 配置自定义行高选项
+ */
+export type SizeItem = {
+    value?: string;
+    label?: string;
+    height?: number;
+};
+export type Settings = {
+    fields?: Field[];
+    checked?: string[];
+    limit?: number;
+    size?: string;
+    sizeList?: SizeItem[];
+    showLineHeight?: boolean;
+};
+export type ISettingPropType = Settings | boolean;
+export type Field = {
+    label: string;
+    field?: string;
+    disabled?: boolean;
+    id?: string;
+    name?: string;
+};
+export type LabelFunctionString = ((_column: any, _index: any) => string | number | boolean | JSX.Element) | string | number | boolean;
+export declare const LabelFunctionStringType: import("vue-types").VueTypeDef<LabelFunctionString>;
+export type RenderFunctionString = ({ cell, data, row, column, index, rows, }: {
+    cell: any;
+    data: any;
+    row: any;
+    column: any;
+    index: any;
+    rows: any;
+}) => string | number | boolean | JSX.Element;
+export declare const RenderFunctionStringType: import("vue-types").VueTypeDef<RenderFunctionString>;
+export type SpanFunctionString = (({ column, colIndex, row, rowIndex }: {
+    column: any;
+    colIndex: any;
+    row: any;
+    rowIndex: any;
+}) => number) | Number;
+export declare const SpanFunctionStringType: import("vue-types").VueTypeDef<SpanFunctionString>;
+export type RowClassFunctionString = ((row: any) => string) | string;
+export declare const RowClassFunctionStringType: import("vue-types").VueTypeDef<RowClassFunctionString>;
+export type RowHeightFunctionNumber = ((_type: string, _row: any, _rowIndex: number, _size?: any) => number) | number;
+export declare const RowHeightFunctionNumberType: import("vue-types").VueTypeDef<RowHeightFunctionNumber>;
+type FunctionNumber = Function | number;
+export declare const FunctionNumberType: import("vue-types").VueTypeDef<FunctionNumber>;
+type StringNumber = string | number;
+export declare const StringNumberType: (val: number | string) => import("vue-types").VueTypeDef<StringNumber> & {
+    default: StringNumber;
+};
+/**
+ * 表格字段解释说明
+ */
+export type IColumnExplain = {
+    content: LabelFunctionString;
+    head: LabelFunctionString | boolean;
+} | boolean;
+export type Column = {
+    label: LabelFunctionString;
+    field?: LabelFunctionString;
+    render?: RenderFunctionString;
+    renderHead?: RenderFunctionString;
+    width?: number | string;
+    minWidth?: number | string;
+    columnKey?: string;
+    showOverflowTooltip?: boolean | IOverflowTooltip;
+    type?: string;
+    fixed?: string | boolean;
+    resizable?: boolean;
+    sort?: ISortShape | boolean | string;
+    filter?: IFilterShape | boolean | string;
+    colspan?: SpanFunctionString;
+    rowspan?: SpanFunctionString;
+    textAlign?: string;
+    className?: RowClassFunctionString;
+    align?: string;
+    prop?: LabelFunctionString;
+    index?: Number;
+    explain?: IColumnExplain;
+};
+export declare const IColumnProp: import("vue-types").VueTypeDef<Column>;
+export type Thead = {
+    height?: Number;
+    isShow?: boolean;
+    cellFn?: Function;
+    color?: IHeadColor | string;
+};
+export type Columns = ReadonlyArray<Column>;
+export type TablePropTypes = Readonly<ExtractPropTypes<typeof tableProps>>;
+export type GroupColumn = {
+    calcWidth?: number;
+    resizeWidth?: number;
+    isHidden?: boolean;
+    listeners?: Map<string, any>;
+} & Column;
+export type IColumnActive = {
+    index: number;
+    active: boolean;
+};
+export type IReactiveProp = {
+    activeColumns: IColumnActive[];
+    rowActions: Record<string, any>;
+    scrollTranslateY: Number;
+    scrollTranslateX: Number;
+    pos: Record<string, any>;
+    settings: Settings | boolean;
+    setting: {
+        size: string;
+        height: Number;
     };
-    colspan: import("vue-types").VueTypeDef<any>;
-    rowspan: import("vue-types").VueTypeDef<any>;
-    align: import("vue-types").VueTypeDef<"" | "right" | "left" | "center">;
-    className: import("vue-types").VueTypeDef<any>;
+    defaultSort: Record<string, any>;
+};
+export type Colgroups = Column & {
+    calcWidth: number;
+    resizeWidth: number;
+    listeners: Map<string, Function>;
 };
-export type TableColumnProps = Partial<ExtractPropTypes<typeof IColumnType>>;
+export declare enum IColSortBehavior {
+    /**
+     * 列排序是相互依赖的
+     */
+    interdependent = "interdependent",
+    /**
+     * 列与列之间的排序是独立的，互斥的
+     */
+    independent = "independent"
+}
 export declare const tableProps: {
     /**
      * 渲染列表
@@ -153,29 +246,37 @@ export declare const tableProps: {
      * 默认：auto 根据行数自动填充高度
      * 100%，依赖初始化时父级容器高度
      */
-    height: import("vue-types").VueTypeDef<string | number> & {
-        default: string | number;
+    height: import("vue-types").VueTypeDef<StringNumber> & {
+        default: StringNumber;
+    };
+    /**
+     * 是否为斑马纹 Table
+     */
+    stripe: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
     };
     /**
      * 设置表格最小高度
      * 默认：300
      */
-    minHeight: import("vue-types").VueTypeDef<string | number> & {
-        default: string | number;
+    minHeight: import("vue-types").VueTypeDef<StringNumber> & {
+        default: StringNumber;
     };
     /**
      * 设置表格最d大高度
      * 默认：auto，依赖外层高度
      */
-    maxHeight: import("vue-types").VueTypeDef<string | number> & {
-        default: string | number;
+    maxHeight: import("vue-types").VueTypeDef<StringNumber> & {
+        default: StringNumber;
     };
     /**
      * 行高，可以为固定数值类型
      * 可以是函数，返回当前行的高度，返回值为数值类型
      */
-    rowHeight: import("vue-types").VueTypeDef<any> & {
-        default: any;
+    rowHeight: import("vue-types").VueTypeDef<RowHeightFunctionNumber> & {
+        default: RowHeightFunctionNumber;
     };
     /**
      * Thead行高，可以为固定数值类型
@@ -196,14 +297,8 @@ export declare const tableProps: {
     /**
      * table header config
      */
-    thead: import("vue-types").VueTypeShape<Thead>;
-    /**
-     * 是否为斑马纹 Table
-     */
-    stripe: import("vue-types").VueTypeValidableDef<boolean> & {
-        default: boolean;
-    } & {
-        default: boolean;
+    thead: import("vue-types").VueTypeDef<Thead> & {
+        default: () => Thead;
     };
     /**
      * 是否启用虚拟渲染 & 滚动
@@ -252,6 +347,14 @@ export declare const tableProps: {
     } & {
         default: boolean;
     };
+    /**
+     * 是否支持跨页全选
+     */
+    acrossAll: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
+    };
     /**
      * 空数据展示
      */
@@ -259,25 +362,15 @@ export declare const tableProps: {
         default: string;
     };
     /**
-     * bk-table-setting-content
+     * 单元格数据为空展示
      */
-    settings: import("vue-types").VueTypeDef<boolean | {
-        fields: Field[] | (() => Field[]);
-        checked: string[] | (() => string[]);
-        limit: number;
-        size: "small" | "medium" | "large";
-        sizeList: SizeItem[] | (object & (() => SizeItem[]));
-        showLineHeight: (boolean | object | (() => boolean) | ((props: Record<string, unknown>) => boolean)) & boolean;
-    }> & {
-        default: boolean | (() => {
-            fields: Field[] | (() => Field[]);
-            checked: string[] | (() => string[]);
-            limit: number;
-            size: "small" | "medium" | "large";
-            sizeList: SizeItem[] | (object & (() => SizeItem[]));
-            showLineHeight: (boolean | object | (() => boolean) | ((props: Record<string, unknown>) => boolean)) & boolean;
-        });
+    emptyCellText: import("vue-types").VueTypeDef<any> & {
+        default: any;
     };
+    /**
+     * bk-table-setting-content
+     */
+    settings: import("vue-types").VueTypeDef<ISettingPropType>;
     /**
      * 行的 class 的回调方法，也可以使用一个固定的 Object 为所有行设置一样的 Style
      */
@@ -331,6 +424,17 @@ export declare const tableProps: {
     } & {
         default: string;
     };
+    /**
+     * 默认选中行
+     * 仅对设置了selection的情况下生效
+     * 值可以为 [key1, key2, key3, ...] 或者 [row1, row2, row3, ...]
+     * 如果设置为key，则 selectionKey 必须设置，内部匹配逻辑为：row[selectionKey] === key
+     */
+    checked: import("vue-types").VueTypeValidableDef<unknown[]> & {
+        default: () => unknown[];
+    } & {
+        default: () => unknown[];
+    };
     /**
      * 提供自定义判定当前行是否选中
      * 如果设置了此属性，其他判定均不生效
@@ -354,9 +458,7 @@ export declare const tableProps: {
      * 当内容过长被隐藏时显示 tooltip, 此处为全局配置, 如果只配置此处，整个table都启用
      * column内部可以单个配置覆盖此配置
      */
-    showOverflowTooltip: import("vue-types").VueTypeDef<boolean | IOverflowTooltip> & {
-        default: boolean | (() => IOverflowTooltip);
-    };
+    showOverflowTooltip: import("vue-types").VueTypeDef<IOverflowTooltipProp>;
     /**
      * 为避免不必要的数据修改导致的不可控组件更新
      * 默认组件不会对传入组件的data进行任何修改
@@ -416,84 +518,20 @@ export declare const tableProps: {
     prependStyle: import("vue-types").VueTypeDef<import("vue").CSSProperties> & {
         default: () => import("vue").CSSProperties;
     };
+    /**
+     * 列排序行为
+     * independent：列与列之间的排序是独立的，互斥的
+     * interdependent：列排序是相互影响、依赖的
+     *
+     */
+    colSortBehavior: import("vue-types").VueTypeDef<IColSortBehavior>;
+    /**
+     * 是否采用flex布局表格
+     */
+    isFlex: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
+    };
 };
-/**
- * 配置自定义行高选项
- */
-export type SizeItem = {
-    value?: string;
-    label?: string;
-    height?: number;
-};
-export type Settings = {
-    fields?: Field[];
-    checked?: string[];
-    limit?: number;
-    size?: string;
-    sizeList?: SizeItem[];
-    showLineHeight?: boolean;
-};
-export type Field = {
-    label: string;
-    field?: string;
-    disabled?: boolean;
-};
-export type Column = {
-    label: Function | string;
-    field?: Function | string;
-    render?: Function | string | Slot;
-    width?: number | string;
-    minWidth?: number | string;
-    columnKey?: string;
-    showOverflowTooltip?: boolean | IOverflowTooltip;
-    type?: string;
-    fixed?: string | boolean;
-    resizable?: boolean;
-    sort?: {
-        sortFn?: Function;
-        sortScope?: string;
-        value?: string;
-    } | boolean | string;
-    filter?: {
-        list?: any;
-        filterFn?: Function;
-        checked?: any;
-    } | boolean | string;
-    colspan?: Function | Number;
-    rowspan?: Function | Number;
-    textAlign?: String;
-    className?: string | Function;
-    align?: string;
-};
-export type Thead = {
-    height?: Number;
-    isShow?: boolean;
-    cellFn?: Function;
-};
-export type GroupColumn = {
-    calcWidth?: number;
-    resizeWidth?: number;
-    isHidden?: boolean;
-    listeners?: Map<string, any>;
-} & Column;
-export type Columns = ReadonlyArray<Column>;
-export type TablePropTypes = Readonly<ExtractPropTypes<typeof tableProps>>;
-export type IColumnActive = {
-    index: number;
-    active: boolean;
-};
-export type IReactiveProp = {
-    activeColumns: IColumnActive[];
-    rowActions: Record<string, any>;
-    scrollTranslateY: Number;
-    scrollTranslateX: Number;
-    pos: Record<string, any>;
-    settings: any;
-    setting: any;
-    defaultSort: Record<string, any>;
-};
-export type Colgroups = Column & {
-    calcWidth: number;
-    resizeWidth: number;
-    listeners: Map<string, Function>;
-};
+export {};

package/lib/table/render.d.ts

@@ -1,12 +1,12 @@
-import { ComputedRef, Ref } from 'vue';
+import { ComputedRef, Ref, SetupContext } from 'vue';
 import type { Language } from '../locale';
 import { TablePlugins } from './plugins';
-import { GroupColumn, IColumnActive, IReactiveProp, TablePropTypes } from './props';
+import { Column, TablePropTypes } from './props';
+import { ITableFormatData, ITableResponse } from './use-attributes';
 export default class TableRender {
     props: TablePropTypes;
-    context: any;
-    reactiveProp: any;
-    colgroups: GroupColumn[];
+    context: SetupContext;
+    tableResp: ITableResponse;
     uuid: string;
     events: Map<string, any[]>;
     styleRef: ComputedRef<{
@@ -15,8 +15,9 @@ export default class TableRender {
     t: ComputedRef<Language['table']>;
     activeSortIndex: Ref<number>;
     plugins: TablePlugins;
-    constructor(props: any, ctx: any, reactiveProp: IReactiveProp, colgroups: GroupColumn[], styleRef: any, t: ComputedRef<Language['table']>);
-    get propActiveCols(): IColumnActive[];
+    constructor(props: any, ctx: any, tableResp: ITableResponse, styleRef: any, t: ComputedRef<Language['table']>);
+    get formatData(): ITableFormatData;
+    get columns(): Column[];
     /**
      * 渲染Table Head
      */
@@ -26,7 +27,9 @@ export default class TableRender {
      * @param rows 表格数据
      * @returns
      */
-    renderTableBodySchema(rows: any[]): any;
+    renderTableBodySchema(rows: any[]): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+        [key: string]: any;
+    }>[] | JSX.Element;
     renderTableFooter(options: any): JSX.Element;
     getRowHeight: (row?: any, rowIndex?: number) => any;
     /**
@@ -36,12 +39,6 @@ export default class TableRender {
      */
     on(eventName: string, watcher: Function): this;
     destroy(): void;
-    /**
-     * 派发事件
-     * @param eventName
-     * @param args
-     */
-    private emitEvent;
     private handlePageLimitChange;
     private handlePageChange;
     /**
@@ -49,7 +46,7 @@ export default class TableRender {
      * @param index 指定选中的列Index
      * @param single 是否重置其他列，当只允许选中一列的情况下需要先重置
      */
-    private setColumnActive;
+    private getSortFnByColumn;
     /**
      * 点击选中一列事件
      * @param index 当前选中列Index
@@ -121,7 +118,6 @@ export default class TableRender {
      * @param colIndex 指定列Index
      * @returns
      */
-    private isColActive;
     /**
      * 渲染表格Col分组
      * @returns
@@ -131,8 +127,4 @@ export default class TableRender {
      * 过滤当前可渲染的列
      */
     private get filterColGroups();
-    /**
-     * 当前Table Setting
-     */
-    private get setting();
 }