stk-table-vue 0.6.17 → 0.7.1

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

@@ -38,7 +38,7 @@ export type CustomCell<T extends CustomCellProps<U> | CustomHeaderCellProps<U>,
 /** 表格列配置 */
 export type StkTableColumn<T extends Record<string, any>> = {
     /**
-     * 用于区分相同dataIndex 的列。
+     * 列唯一键，(可选)，不传则默认取dataIndex 字段作为列唯一键。
      */
     key?: any;
     /**
@@ -46,8 +46,9 @@ export type StkTableColumn<T extends Record<string, any>> = {
      * - seq 序号列
      * - expand 展开列
      * - dragRow 拖拽列(使用sktTableRef.getTableData 获取改变后的顺序)
+     * - tree-node 树节点列，这一列前面有展开收起箭头
      */
-    type?: 'seq' | 'expand' | 'dragRow';
+    type?: 'seq' | 'expand' | 'dragRow' | 'tree-node';
     /** 取值id */
     dataIndex: keyof T & string;
     /** 表头文字 */
@@ -122,18 +123,31 @@ export type PrivateRowDT = {
      * If user define the `__ROW_KEY__` in table data, this value will be used as the row key
      * @private
      */
-    __ROW_KEY__: string;
+    __ROW_KEY__?: string;
     /**
      * if row expanded
      * @private
      */
     __EXPANDED__?: StkTableColumn<any> | null;
+    /**
+     * if tree node row expanded
+     * @private
+     */
+    __T_EXPANDED__?: boolean;
+    /**
+     * tree parent key
+     * @private
+     */
+    __T_PARENT_K__?: UniqKey;
+    /**
+     * tree level
+     * @private
+     */
+    __T_LV__?: number;
 };
 export type SortOption<T extends Record<string, any>> = Pick<StkTableColumn<T>, 'sorter' | 'dataIndex' | 'sortField' | 'sortType'>;
-export type SortState<T> = {
-    dataIndex: keyof T;
+export type SortState<T extends Record<string, any>> = Pick<StkTableColumn<T>, 'dataIndex' | 'sortField' | 'sortType'> & {
     order: Order;
-    sortType?: 'number' | 'string';
 };
 export type UniqKey = string | number;
 export type UniqKeyFun = (param: any) => UniqKey;
@@ -197,8 +211,14 @@ export type ExpandedRow = PrivateRowDT & {
 export type DragRowConfig = {
     mode?: 'none' | 'insert' | 'swap';
 };
+/** 树形配置 */
+export type TreeConfig = {
+    defaultExpandAll?: boolean;
+    defaultExpandKeys?: UniqKey[];
+    defaultExpandLevel?: number;
+};
 /** header drag config */
-export type HeaderDragConfig<DT extends Record<string, any> = any> = boolean | {
+export type HeaderDragConfig<DT extends Record<string, any> = any> = {
     /**
      * 列交换模式
      * - none - 不做任何事

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

@@ -11,7 +11,7 @@ type Params = {
  * 高亮单元格，行
  */
 export declare function useHighlight({ props, stkTableId, tableContainerRef }: Params): {
-    highlightSteps: number | null;
+    highlightSteps: import('vue').ComputedRef<number | null>;
     setHighlightDimRow: (rowKeyValues: UniqKey[], option?: HighlightDimRowOption) => void;
     setHighlightDimCell: (rowKeyValue: UniqKey, colKeyValue: string, option?: HighlightDimCellOption) => void;
 };

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

@@ -0,0 +1,17 @@
+import { ShallowRef } from 'vue';
+import { PrivateRowDT, StkTableColumn, UniqKey } from './types';
+
+type DT = PrivateRowDT;
+type Option<DT extends Record<string, any>> = {
+    rowKeyGen: (row: any) => UniqKey;
+    dataSourceCopy: ShallowRef<DT[]>;
+    emits: any;
+};
+export declare function useRowExpand({ dataSourceCopy, rowKeyGen, emits }: Option<DT>): {
+    toggleExpandRow: (row: DT, col: StkTableColumn<DT>) => void;
+    setRowExpand: (rowKeyOrRow: string | undefined | DT, expand?: boolean, data?: {
+        col?: StkTableColumn<DT>;
+        silent?: boolean;
+    }) => void;
+};
+export {};

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

@@ -0,0 +1,20 @@
+import { ShallowRef } from 'vue';
+import { PrivateRowDT, UniqKey } from './types';
+
+type DT = PrivateRowDT & {
+    children?: DT[];
+};
+type Option<DT extends Record<string, any>> = {
+    props: any;
+    rowKeyGen: (row: any) => UniqKey;
+    dataSourceCopy: ShallowRef<DT[]>;
+    emits: any;
+};
+export declare function useTree({ props, dataSourceCopy, rowKeyGen, emits }: Option<DT>): {
+    toggleTreeNode: (row: DT, col: any) => void;
+    setTreeExpand: (row: (UniqKey | DT) | (UniqKey | DT)[], option?: {
+        expand?: boolean;
+    }) => void;
+    flatTreeData: (data: DT[]) => DT[];
+};
+export {};

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

@@ -14,7 +14,9 @@ export declare function isEmptyValue(val: any, isNumber?: boolean): boolean;
  * @param targetArray 表格数据
  * @return targetArray 的浅拷贝
  */
-export declare function insertToOrderedArray<T extends object>(sortState: SortState<T>, newItem: T, targetArray: T[], sortConfig?: SortConfig<T>): T[];
+export declare function insertToOrderedArray<T extends object>(sortState: SortState<T>, newItem: T, targetArray: T[], sortConfig?: SortConfig<T> & {
+    customCompare?: (a: T, b: T) => number;
+}): T[];
 /**
  * 二分查找
  *  @param searchArray 查找数组