stk-table-vue 0.11.1 → 0.11.3

package/lib/index-t5SJ6KNv.js

@@ -1,6 +1,6 @@
 /**
  * name: stk-table-vue
- * version: v0.11.1
+ * version: v0.11.3
  * description: High performance realtime virtual table for vue3 and vue2.7
  * author: japlus
  * homepage: https://ja-plus.github.io/stk-table-vue/

package/lib/src/StkTable/StkTable.vue.d.ts

@@ -1,5 +1,5 @@
 import { FilterStatus } from './components/Filter/types';
-import { AreaSelectionConfig, AreaSelectionRange, AutoRowHeightConfig, ColResizableConfig, DragRowConfig, ExpandConfig, ExperimentalConfig, HeaderDragConfig, HighlightConfig, Order, PrivateRowDT, PrivateStkTableColumn, RowActiveOption, SeqConfig, SortConfig, SortOption, StkTableColumn, TreeConfig, UniqKey, UniqKeyProp } from './types/index';
+import { AreaSelectionConfig, AreaSelectionRange, AutoRowHeightConfig, ColResizableConfig, DragRowConfig, ExpandConfig, ExperimentalConfig, FooterConfig, HeaderDragConfig, HighlightConfig, Order, PrivateRowDT, PrivateStkTableColumn, RowActiveOption, SeqConfig, SortConfig, SortOption, SortState, StkTableColumn, TreeConfig, UniqKey, UniqKeyProp } from './types/index';
 import { ScrollbarOptions } from './useScrollbar';
 
 /** Generic stands for DataType */
@@ -36,6 +36,7 @@ declare function setSelectedCell(row?: DT, col?: StkTableColumn<DT>, option?: {
  * @param option.sort 是否触发排序-默认true
  * @param option.silent 是否禁止触发回调-默认true
  * @param option.force 是否触发排序-默认true
+ * @param option.append 是否追加排序（多列排序模式）。为true时保留现有排序状态，将新排序添加到最前面；为false时替换所有排序状态
  * @return 表格数据
  */
 declare function setSorter(colKey: string, order: Order, option?: {
@@ -43,6 +44,7 @@ declare function setSorter(colKey: string, order: Order, option?: {
     force?: boolean;
     silent?: boolean;
     sort?: boolean;
+    append?: boolean;
 }): any[];
 declare function resetSorter(): void;
 /**
@@ -58,8 +60,8 @@ declare function getTableData(): any[];
  * @return {{key:string,order:Order}[]}
  */
 declare function getSortColumns(): {
-    key: string | number | symbol | undefined;
-    order: "desc" | "asc";
+    key: keyof DT | undefined;
+    order: Order;
 }[];
 declare function __VLS_template(): {
     tableHeader?(_: {
@@ -228,6 +230,8 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     experimental?: ExperimentalConfig;
     /** 表格底部合计行数据 */
     footerData?: DT[];
+    /** 表格底部配置 */
+    footerConfig?: FooterConfig;
 }>, {
     width: string;
     fixedMode: boolean;
@@ -285,6 +289,9 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     scrollRowByRow: boolean;
     scrollbar: boolean;
     experimental: () => {};
+    footerConfig: () => {
+        position: string;
+    };
 }>>, {
     /**
      * 重新计算虚拟列表宽高
@@ -340,7 +347,25 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
      *
      * en: Table sort column colKey
      */
-    sortCol: import('vue').Ref<string | number | symbol | undefined, string | number | symbol | undefined>;
+    sortCol: import('vue').ComputedRef<string | number | symbol | undefined>;
+    /**
+     * 排序状态数组
+     *
+     * en: Multi-column sort states array
+     */
+    sortStates: import('vue').Ref<{
+        key?: any;
+        dataIndex: string;
+        sortField?: string | number | symbol | undefined;
+        sortType?: "number" | "string" | undefined;
+        order: Order;
+    }[], SortState<any>[] | {
+        key?: any;
+        dataIndex: string;
+        sortField?: string | number | symbol | undefined;
+        sortType?: "number" | "string" | undefined;
+        order: Order;
+    }[]>;
     /**
      * 表格排序列顺序
      *
@@ -660,6 +685,8 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     experimental?: ExperimentalConfig;
     /** 表格底部合计行数据 */
     footerData?: DT[];
+    /** 表格底部配置 */
+    footerConfig?: FooterConfig;
 }>, {
     width: string;
     fixedMode: boolean;
@@ -717,6 +744,9 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     scrollRowByRow: boolean;
     scrollbar: boolean;
     experimental: () => {};
+    footerConfig: () => {
+        position: string;
+    };
 }>>> & Readonly<{
     onScroll?: ((ev: Event, data: {
         startIndex: number;
@@ -829,6 +859,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     scrollRowByRow: boolean | "scrollbar";
     experimental: ExperimentalConfig;
     footerData: DT[];
+    footerConfig: FooterConfig;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;

package/lib/src/StkTable/index.d.ts

@@ -1,6 +1,6 @@
 export { default as StkTable } from './StkTable.vue';
 export { tableSort, insertToOrderedArray, strCompare, binarySearch } from './utils';
-export type { StkTableColumn } from './types/index';
+export type { StkTableColumn, SortState, SortConfig, SortOption, Order } from './types/index';
 export { useAreaSelection } from './features/index';
 export { registerFeature } from './registerFeature';
 export { useFilter } from './components/Filter';

package/lib/src/StkTable/types/index.d.ts

@@ -187,12 +187,37 @@ export type PrivateRowDT = {
     children?: any[];
 };
 export type SortOption<T extends Record<string, any>> = Pick<StkTableColumn<T>, 'sorter' | 'dataIndex' | 'sortField' | 'sortType'>;
-export type SortState<T extends Record<string, any>> = Pick<StkTableColumn<T>, 'dataIndex' | 'sortField' | 'sortType'> & {
+/**
+ * 单列排序状态
+ */
+export type SortState<T extends Record<string, any>> = Pick<StkTableColumn<T>, 'key' | 'dataIndex' | 'sortField' | 'sortType'> & {
     order: Order;
 };
 export type UniqKey = string | number;
 export type UniqKeyFun = (param: any) => UniqKey;
 export type UniqKeyProp = UniqKey | UniqKeyFun;
+/**
+ * 默认排序配置
+ */
+export type DefaultSortConfig<T extends Record<string, any>> = {
+    /**
+     * colKey
+     *
+     * if set `props.colKey`
+     *
+     * default: StkTableColumn<T>['dataIndex']
+     */
+    key?: StkTableColumn<T>['key'];
+    dataIndex: StkTableColumn<T>['dataIndex'];
+    order: Order;
+    sortField?: StkTableColumn<T>['sortField'];
+    sortType?: StkTableColumn<T>['sortType'];
+    sorter?: StkTableColumn<T>['sorter'];
+    /**
+     * whether to disable trigger`sort-change` event. default: false
+     */
+    silent?: boolean;
+};
 export type SortConfig<T extends Record<string, any>> = {
     /**
      * TODO: Sort icon display strategy
@@ -204,25 +229,7 @@ export type SortConfig<T extends Record<string, any>> = {
      * 1. trigger when init
      * 2. trigger when sort direction is null
      */
-    defaultSort?: {
-        /**
-         * colKey
-         *
-         * if set `props.colKey`
-         *
-         * default: StkTableColumn<T>['dataIndex']
-         */
-        key?: StkTableColumn<T>['key'];
-        dataIndex: StkTableColumn<T>['dataIndex'];
-        order: Order;
-        sortField?: StkTableColumn<T>['sortField'];
-        sortType?: StkTableColumn<T>['sortType'];
-        sorter?: StkTableColumn<T>['sorter'];
-        /**
-         * whether to disable trigger`sort-change` event. default: false
-         */
-        silent?: boolean;
-    };
+    defaultSort?: DefaultSortConfig<T>;
     /** empty value always sort to bottom */
     emptyToBottom?: boolean;
     /**
@@ -234,6 +241,17 @@ export type SortConfig<T extends Record<string, any>> = {
      * whether to sort children when sort current column. default: false
      */
     sortChildren?: boolean;
+    /**
+     * 是否启用多列排序
+     * - false (default): 单列排序，点击新列会取消之前列的排序
+     * - true: 多列排序，支持同时按多列排序，通过点击顺序决定优先级
+     */
+    multiSort?: boolean;
+    /**
+     * 多列排序时的最大列数限制
+     * default: 3
+     */
+    multiSortLimit?: number;
 };
 /** th td type */
 export declare const enum TagType {
@@ -329,4 +347,13 @@ export type ExperimentalConfig = {
     /** use transform to simulate scroll */
     scrollY?: boolean;
 };
+/** 表格底部配置 */
+export type FooterConfig = {
+    /**
+     * 表格底部吸附位置
+     * - bottom: 吸附在表格底部（默认）
+     * - top: 吸附在表格顶部
+     */
+    position?: 'bottom' | 'top';
+};
 export {};

package/lib/src/StkTable/useScrollbar.d.ts

@@ -18,7 +18,7 @@ export type ScrollbarOptions = {
  * @param options 滚动条配置选项
  * @returns 滚动条相关状态和方法
  */
-export declare function useScrollbar(props: any, containerRef: Ref<HTMLDivElement | undefined>, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>, updateVirtualScrollY: (sTop?: number) => void, scrollbarOptions: Ref<Required<ScrollbarOptions>>): readonly [Ref<{
+export declare function useScrollbar(props: any, containerRef: Ref<HTMLDivElement | undefined>, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>, updateVirtualScrollY: (sTop?: number) => void, scrollbarOptions: Ref<Required<ScrollbarOptions>>, isExperimentalScrollY: Ref<boolean | undefined>): readonly [Ref<{
     h: number;
     w: number;
     t: number;

package/lib/src/StkTable/useVirtualScroll.d.ts

@@ -41,7 +41,7 @@ export type VirtualScrollXStore = {
  * virtual scroll
  * @returns
  */
-export declare function useVirtualScroll<DT extends Record<string, any>>(props: any, tableContainerRef: Ref<HTMLElement | undefined>, trRef: Ref<HTMLTableRowElement[] | undefined>, dataSourceCopy: ShallowRef<PrivateRowDT[]>, tableHeaderLast: ShallowRef<PrivateStkTableColumn<PrivateRowDT>[]>, tableHeaders: ShallowRef<PrivateStkTableColumn<PrivateRowDT>[][]>, rowKeyGen: RowKeyGen, maxRowSpan: Map<UniqKey, number>, scrollbarOptions: Ref<Required<ScrollbarOptions>>): readonly [Ref<{
+export declare function useVirtualScroll<DT extends Record<string, any>>(props: any, tableContainerRef: Ref<HTMLElement | undefined>, trRef: Ref<HTMLTableRowElement[] | undefined>, dataSourceCopy: ShallowRef<PrivateRowDT[]>, tableHeaderLast: ShallowRef<PrivateStkTableColumn<PrivateRowDT>[]>, tableHeaders: ShallowRef<PrivateStkTableColumn<PrivateRowDT>[][]>, rowKeyGen: RowKeyGen, maxRowSpan: Map<UniqKey, number>, scrollbarOptions: Ref<Required<ScrollbarOptions>>, isExperimentalScrollY: Ref<boolean | undefined>): readonly [Ref<{
     containerHeight: number;
     pageSize: number;
     startIndex: number;