stk-table-vue 0.11.11 → 0.11.13

package/lib/{index-C40Rz-HL.js → index-BzpbBYPO.js}

@@ -1,12 +1,12 @@
 /**
  * name: stk-table-vue
- * version: v0.11.11
+ * version: v0.11.12
  * description: High performance realtime virtual table for vue3 and vue2.7
  * author: japlus
  * homepage: https://ja-plus.github.io/stk-table-vue/
  * license: MIT
  */
-import { defineComponent, ref, reactive, h, onMounted, onUnmounted, createElementBlock, openBlock, withModifiers, normalizeStyle, normalizeClass, createElementVNode, createVNode, nextTick } from "vue";
+import { defineComponent, ref, reactive, h, onMounted, onUnmounted, createElementBlock, openBlock, withModifiers, normalizeStyle, normalizeClass, createVNode, createElementVNode, nextTick } from "vue";
 import { StkTable as _sfc_main$1 } from "./stk-table-vue.js";
 const DROPDOWN_DEFAULT_WIDTH = 300;
 const DROPDOWN_DEFAULT_HEIGHT = 400;
@@ -140,7 +140,6 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
         onClick: _cache[0] || (_cache[0] = withModifiers(() => {
         }, ["stop"]))
       }, [
-        _cache[1] || (_cache[1] = createElementVNode("div", { style: { "padding": "4px" } }, "Filter (Beta)", -1)),
         createVNode(_sfc_main$1, {
           "row-key": "id",
           headless: "",

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

@@ -1,4 +1,4 @@
-import { FilterStatus } from './components/Filter/types';
+import { FilterStatus } from './custom-cells/Filter/types';
 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';
 
@@ -343,6 +343,8 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<im
      * @see {@link getTableData}
      */
     getTableData: () => any[];
+    getRowIndex: (row: any) => number;
+    getColumnIndex: (column: PrivateStkTableColumn<any>) => number;
     /**
      * 设置展开的行
      *
@@ -391,6 +393,13 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<im
         cols: StkTableColumn<any>[];
         ranges: AreaSelectionRange[];
     };
+    /**
+     * 设置拖选选区
+     *
+     * en: Set cell selection range (areaSelection=true)
+     * @see {@link setAreaSelection}
+     */
+    setAreaSelection: (ranges?: import('./types/index').AreaSelectionSetterRange<any> | undefined, option?: import('./types/index').AreaSelectionSetterOption) => AreaSelectionRange[];
     /**
      * 清空拖选选区
      *
@@ -406,9 +415,9 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<im
      */
     copySelectedArea: () => string;
     /**
-     * 设置筛选状态
+     * 设置筛选状态(Beta)
      *
-     * en: Set filter status
+     * en: Set filter status(Beta)
      * @see {@link setFilter}
      */
     setFilter: (status: Record<UniqKey, FilterStatus> | null, option?: {

package/lib/src/StkTable/custom-cells/EditableCell/EditableCell.vue.d.ts

@@ -0,0 +1,18 @@
+import { CustomCellProps } from '../../types';
+
+declare const _default: <T extends Record<string, any>>(__VLS_props: Awaited<typeof __VLS_setup>["props"], __VLS_ctx?: __VLS_Prettify<Pick<Awaited<typeof __VLS_setup>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_Prettify<__VLS_OmitKeepDiscriminatedUnion<(Partial<{}> & Omit<{} & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>) & (CustomCellProps<T> & {
+        trigger?: "dblclick" | "click";
+        onChange?: (newValue: any) => void;
+    }), keyof import('vue').VNodeProps | keyof import('vue').AllowedComponentProps>> & {} & (import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps);
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: ReturnType<() => {}>;
+    emit: typeof __VLS_emit;
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/lib/src/StkTable/custom-cells/EditableCell/createEditableCell.d.ts

@@ -0,0 +1,33 @@
+/** createEditableCell 配置选项 */
+export interface CreateEditableCellOptions {
+    /** 触发编辑的事件，默认 'dblclick' */
+    trigger?: 'dblclick' | 'click';
+    /** 值变更回调 */
+    onChange?: (newValue: any, row: Record<string, any>, dataIndex: string) => void;
+}
+/**
+ * 可编辑单元格工厂函数
+ * @param option 配置选项
+ * @returns EditableCell 组件
+ */
+export declare function createEditableCell(option?: CreateEditableCellOptions): {
+    EditableCell: () => import('vue').Raw<import('vue').DefineComponent<{
+        row: any;
+        col: import('../..').StkTableColumn<any>;
+        cellValue: any;
+        rowIndex: number;
+        colIndex: number;
+        expanded?: import('../..').StkTableColumn<any> | undefined;
+        treeExpanded?: boolean | undefined;
+    }, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+        row: any;
+        col: import('../..').StkTableColumn<any>;
+        cellValue: any;
+        rowIndex: number;
+        colIndex: number;
+        expanded?: import('../..').StkTableColumn<any> | undefined;
+        treeExpanded?: boolean | undefined;
+    }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>>;
+};

package/lib/src/StkTable/custom-cells/EditableCell/index.d.ts

@@ -0,0 +1,3 @@
+export { default as EditableCell } from './EditableCell.vue';
+export { createEditableCell } from './createEditableCell';
+export type { CreateEditableCellOptions } from './createEditableCell';

package/lib/src/StkTable/{components/Filter/useFilter.d.ts → custom-cells/Filter/createFilter.d.ts}

@@ -1,24 +1,14 @@
-import { UniqKey } from '../../types';
+import { CustomHeaderCellProps, UniqKey } from '../../types';
 import { VNode } from 'vue';
-import { FilterOption, FilterStatus } from './types';
+import { CreateFilterOption, FilterComponentConfig, FilterStatus } from './types';
 
 /**
- * 从数据源提取筛选选项
- * @param dataSource 数据源
- * @param columnKey 列名
- * @returns 筛选选项数组
-//  */
-/**
- * 表格筛选功能Hook (BETA)
+ * 表格筛选功能工厂函数 (BETA)
  * @beta
  * @returns
  */
-export declare function useFilter(option?: {
-    remote?: boolean;
-}): {
-    Filter: (config?: {
-        options?: FilterOption[];
-    }, component?: VNode) => import('vue').Raw<import('vue').DefineComponent<{
+export declare function createFilter(option?: CreateFilterOption): {
+    Filter: (config?: FilterComponentConfig, component?: VNode | ((props: CustomHeaderCellProps<any>) => VNode)) => import('vue').Raw<import('vue').DefineComponent<{
         col: import('../../types').StkTableColumn<any>;
         rowIndex: number;
         colIndex: number;

package/lib/src/StkTable/custom-cells/Filter/index.d.ts

@@ -0,0 +1,2 @@
+export { createFilter } from './createFilter';
+export type { FilterStatus, CreateFilterOption } from './types';

package/lib/src/StkTable/custom-cells/Filter/types.d.ts

@@ -0,0 +1,38 @@
+/** 筛选选项接口 */
+export interface FilterOption {
+    label: string;
+    value: any;
+    selected?: boolean;
+}
+/** 筛选状态接口 */
+export interface FilterStatus {
+    value: FilterOption['value'][];
+    /**
+     * 自定义筛选逻辑函数。
+     * 当选中筛选条件时，根据此函数的返回值决定记录是否保留。
+     * @param row 当前行数据
+     * @param cellValue 当前单元格的值（即 row[columnKey]）
+     * @param filterValues 当前选中的筛选值数组
+     * @returns 返回 true 保留记录，false 过滤掉
+     */
+    filter?: (args: {
+        row: any;
+        cellValue: any;
+        filterValues: FilterOption['value'][];
+    }) => boolean;
+}
+/** FilterComponent 配置接口 */
+export interface FilterComponentConfig {
+    options?: FilterOption[];
+    filter?: FilterStatus['filter'];
+    /**
+     * 是否自动从数据中提取筛选选项，默认 false
+     * en: Whether to automatically extract filter options from the data source
+     */
+    autoOptions?: boolean;
+}
+/** createFilter选项接口 */
+export interface CreateFilterOption {
+    /** 是否远程筛选 */
+    remote?: boolean;
+}

package/lib/src/StkTable/features/useAreaSelection.d.ts

@@ -1,5 +1,5 @@
 import { Ref, ShallowRef } from 'vue';
-import { AreaSelectionConfig, AreaSelectionRange, CellKeyGen, ColKeyGen, StkTableColumn, UniqKey } from '../types';
+import { AreaSelectionConfig, AreaSelectionRange, CellKeyGen, ColKeyGen, StkTableColumn, UniqKey, AreaSelectionSetterRange, AreaSelectionSetterOption } from '../types';
 import { VirtualScrollStore, VirtualScrollXStore } from '../useVirtualScroll';
 
 /**
@@ -7,7 +7,7 @@ import { VirtualScrollStore, VirtualScrollXStore } from '../useVirtualScroll';
  * 支持鼠标拖拽选择、键盘导航、复制粘贴等功能
  * en: Cell area selection feature with mouse drag, keyboard navigation, copy-paste, etc.
  */
-export declare function useAreaSelection<DT extends Record<string, any>>(props: any, emits: any, tableContainerRef: Ref<HTMLDivElement | undefined>, dataSourceCopy: ShallowRef<DT[]>, tableHeaderLast: ShallowRef<StkTableColumn<DT>[]>, colKeyGen: ColKeyGen, cellKeyGen: CellKeyGen, scrollTo: (top: number | null, left: number | null) => void, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>): {
+export declare function useAreaSelection<DT extends Record<string, any>>(props: any, emits: any, tableContainerRef: Ref<HTMLDivElement | undefined>, dataSourceCopy: ShallowRef<DT[]>, tableHeaderLast: ShallowRef<StkTableColumn<DT>[]>, colKeyGen: ColKeyGen, cellKeyGen: CellKeyGen, scrollTo: (top: number | null, left: number | null) => void, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>, getRowIndex: (row: DT) => number, getColumnIndex: (col: StkTableColumn<DT>) => number): {
     config: import('vue').ComputedRef<AreaSelectionConfig>;
     isSelecting: Ref<boolean, boolean>;
     getClass: (cellKey: string, absoluteRowIndex: number, colKey: UniqKey) => string[];
@@ -17,6 +17,7 @@ export declare function useAreaSelection<DT extends Record<string, any>>(props:
         cols: StkTableColumn<DT>[];
         ranges: AreaSelectionRange[];
     };
+    set: (ranges?: AreaSelectionSetterRange<DT>, option?: AreaSelectionSetterOption) => AreaSelectionRange[];
     clear: () => void;
     copy: () => string;
     onMD: (e: MouseEvent) => void;

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

@@ -1,7 +1,9 @@
-export { default as StkTable } from './StkTable.vue';
-export { tableSort, insertToOrderedArray, strCompare, binarySearch } from './utils';
-export type { StkTableColumn, SortState, SortConfig, SortOption, Order } from './types/index';
 export { useAreaSelection } from './features/index';
 export { registerFeature } from './registerFeature';
-export { useFilter } from './components/Filter';
-export type { FilterStatus, UseFilterOptions } from './components/Filter';
+export { default as StkTable } from './StkTable.vue';
+export type { Order, SortConfig, SortOption, SortState, StkTableColumn } from './types/index';
+export { binarySearch, insertToOrderedArray, strCompare, tableSort } from './utils';
+export { createFilter } from './custom-cells/Filter/index';
+export type { CreateFilterOption, FilterStatus } from './custom-cells/Filter/index';
+export { createEditableCell } from './custom-cells/EditableCell/index';
+export type { CreateEditableCellOptions } from './custom-cells/EditableCell/index';

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

@@ -384,6 +384,21 @@ export type AreaSelectionConfig<T extends Record<string, any> = any> = {
         row?: boolean;
     };
 };
+/** 获取选中的单元格信息 */
+export type AreaSelectionSetterRange<DT extends Record<string, any>> = {
+    begin: {
+        row: number | DT;
+        col?: number | StkTableColumn<DT>;
+    };
+    end?: {
+        row: number | DT;
+        col?: number | StkTableColumn<DT>;
+    };
+};
+export type AreaSelectionSetterOption = {
+    silent?: boolean;
+    scrollToView?: boolean;
+};
 /** 实验性功能配置 */
 export type ExperimentalConfig = {
     /** use transform to simulate scroll */

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

@@ -52,6 +52,8 @@ export declare function transformWidthToStr(width?: string | number): string | u
 export declare function getBrowsersVersion(browserName: string): number;
 export declare function pureCellKeyGen(rowKey: UniqKey, colKey: UniqKey): string;
 export declare function getClosestTr(target: HTMLElement): HTMLTableRowElement | null;
+export declare function getClosestTh(target: HTMLElement): HTMLTableCellElement | null;
+export declare function getClosestTd(target: HTMLElement): HTMLTableCellElement | null;
 export declare function getClosestTrIndex(target: HTMLElement): number;
 export declare function getClosestColKey(target: HTMLElement): string | undefined;
 /**