stk-table-vue 0.11.2 → 0.11.4

package/lib/index-t5SJ6KNv.js

@@ -1,6 +1,6 @@
 /**
  * name: stk-table-vue
- * version: v0.11.2
+ * version: v0.11.4
  * 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, StkTableColumn, TreeConfig, UniqKey, UniqKeyProp } from './types/index';
 import { ScrollbarOptions } from './useScrollbar';
 
 /** Generic stands for DataType */
@@ -28,23 +28,6 @@ declare function setCurrentRow(rowKeyOrRow: string | undefined | DT, option?: {
 declare function setSelectedCell(row?: DT, col?: StkTableColumn<DT>, option?: {
     silent: boolean;
 }): void;
-/**
- * 设置表头排序状态。
- * @param colKey 列唯一键字段。如果你想要取消排序状态，请使用`resetSorter`
- * @param order 正序倒序
- * @param option.sortOption 指定排序参数。同 StkTableColumn 中排序相关字段。建议从columns中find得到。
- * @param option.sort 是否触发排序-默认true
- * @param option.silent 是否禁止触发回调-默认true
- * @param option.force 是否触发排序-默认true
- * @return 表格数据
- */
-declare function setSorter(colKey: string, order: Order, option?: {
-    sortOption?: SortOption<DT>;
-    force?: boolean;
-    silent?: boolean;
-    sort?: boolean;
-}): any[];
-declare function resetSorter(): void;
 /**
  * set scroll bar position
  * @param top null to not change
@@ -53,14 +36,6 @@ declare function resetSorter(): void;
 declare function scrollTo(top?: number | null, left?: number | null): void;
 /** get current table data */
 declare function getTableData(): any[];
-/**
- * get current sort info
- * @return {{key:string,order:Order}[]}
- */
-declare function getSortColumns(): {
-    key: string | number | symbol | undefined;
-    order: "desc" | "asc";
-}[];
 declare function __VLS_template(): {
     tableHeader?(_: {
         col: PrivateStkTableColumn<PrivateRowDT>;
@@ -228,6 +203,8 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     experimental?: ExperimentalConfig;
     /** 表格底部合计行数据 */
     footerData?: DT[];
+    /** 表格底部配置 */
+    footerConfig?: FooterConfig;
 }>, {
     width: string;
     fixedMode: boolean;
@@ -285,6 +262,9 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     scrollRowByRow: boolean;
     scrollbar: boolean;
     experimental: () => {};
+    footerConfig: () => {
+        position: string;
+    };
 }>>, {
     /**
      * 重新计算虚拟列表宽高
@@ -340,28 +320,55 @@ 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;
+    }[], {
+        key?: any;
+        dataIndex: string;
+        sortField?: string | number | symbol | undefined;
+        sortType?: "number" | "string" | undefined;
+        order: Order;
+    }[] | import('.').SortState<any>[]>;
     /**
      * 表格排序列顺序
      *
      * en: get current sort info
      * @see {@link getSortColumns}
      */
-    getSortColumns: typeof getSortColumns;
+    getSortColumns: () => {
+        key: string | number | symbol | undefined;
+        order: Order;
+    }[];
     /**
      * 设置表头排序状态
      *
      * en: Set the sort status of the table header
      * @see {@link setSorter}
      */
-    setSorter: typeof setSorter;
+    setSorter: (colKey: string, order: Order, option?: {
+        sortOption?: import('.').SortOption<any> | undefined;
+        force?: boolean;
+        silent?: boolean;
+        sort?: boolean;
+        append?: boolean;
+    }) => any[];
     /**
      * 重置sorter状态
      *
      * en: Reset the sorter status
      * @see {@link resetSorter}
      */
-    resetSorter: typeof resetSorter;
+    resetSorter: () => void;
     /**
      * 滚动至
      *
@@ -660,6 +667,8 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     experimental?: ExperimentalConfig;
     /** 表格底部合计行数据 */
     footerData?: DT[];
+    /** 表格底部配置 */
+    footerConfig?: FooterConfig;
 }>, {
     width: string;
     fixedMode: boolean;
@@ -717,6 +726,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 +841,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/useSorter.d.ts

@@ -0,0 +1,38 @@
+import { Ref } from 'vue';
+import { Order, SortOption, SortState, StkTableColumn, UniqKey } from './types/index';
+
+/**
+ * 排序 Hook
+ * 管理表格排序状态和相关操作
+ * @param props 表格 props
+ * @param colKeyGen 列 key 生成函数
+ * @param tableHeaderLast 表头最后一行（叶子节点）
+ * @param dataSourceCopy 数据源副本 ref
+ * @param initDataSource 初始化数据源函数
+ * @param emits 事件发射函数
+ * @returns 排序相关状态和方法
+ */
+export declare function useSorter<DT extends Record<string, any>>(props: any, emits: any, colKeyGen: Ref<(col: StkTableColumn<DT>) => string>, tableHeaderLast: Ref<StkTableColumn<DT>[]>, dataSourceCopy: Ref<DT[]>, initDataSource: (data?: DT[], option?: {
+    forceSort?: boolean;
+}) => void): readonly [Ref<{
+    key?: any;
+    dataIndex: import('vue').UnwrapRef<keyof DT & string>;
+    sortField?: import('vue').UnwrapRef<keyof DT> | undefined;
+    sortType?: "number" | "string" | undefined;
+    order: Order;
+}[], SortState<DT>[] | {
+    key?: any;
+    dataIndex: import('vue').UnwrapRef<keyof DT & string>;
+    sortField?: import('vue').UnwrapRef<keyof DT> | undefined;
+    sortType?: "number" | "string" | undefined;
+    order: Order;
+}[]>, import('vue').ComputedRef<keyof DT | undefined>, (col: StkTableColumn<DT> | undefined | null) => void, (colKey: string, order: Order, option?: {
+    sortOption?: SortOption<DT>;
+    force?: boolean;
+    silent?: boolean;
+    sort?: boolean;
+    append?: boolean;
+}) => DT[], () => void, () => {
+    key: keyof DT | undefined;
+    order: Order;
+}[], () => void, (colKey: UniqKey) => SortState<DT> | undefined, (dataSource: DT[]) => DT[]];