stk-table-vue 0.11.7 → 0.11.9

package/README.md

@@ -1,172 +1,173 @@
-<p align="center">
-    <a href="https://ja-plus.github.io/stk-table-vue/">
-        <img src="./docs-src/public/assets/logo.svg" width="152">
-    </a>
-    <h3 align='center'>Stk Table Vue</h3>
-    <p align="center">
-        <a href="https://www.npmjs.com/package/stk-table-vue"><img src="https://img.shields.io/npm/v/stk-table-vue"></a>
-        <a href="https://www.npmjs.com/package/stk-table-vue"><img src="https://img.shields.io/npm/dw/stk-table-vue"></a>
-        <a href="https://github.com/ja-plus/stk-table-vue/stargazers"><img src="https://img.shields.io/github/stars/ja-plus/stk-table-vue.svg"></a>
-        <a href="https://raw.githubusercontent.com/ja-plus/stk-table-vue/master/LICENSE"><img src="https://img.shields.io/npm/l/stk-table-vue"></a>
-        <a href="https://github.com/ja-plus/stk-table-vue"><img src="https://img.shields.io/npm/types/stk-table-vue"></a>
-    </p>
-</p>
-
-> Stk Table Vue(Sticky Table) is a high-performance virtual list component based on Vue.
->
-> Used for real-time data display, with data highlighting and dynamic effects
->
-> Support Vue3 and Vue2.7
-
-
-## Documentation
-### [Stk Table Vue Official en](https://ja-plus.github.io/stk-table-vue/en/)
-### [Stk Table Vue Official zh-CN](https://ja-plus.github.io/stk-table-vue/)
-
-
-## Repo: 
-- [Github](https://github.com/ja-plus/stk-table-vue)
-- [Gitee](https://gitee.com/japlus/stk-table-vue) 🇨🇳
-
-## Demo
-[<span style="font-size: 16px;font-weight: bold;">Online Demo in stackblitz</span>](https://stackblitz.com/edit/vitejs-vite-ad91hh?file=src%2FDemo%2Findex.vue)
-
-## Usage
-> npm install stk-table-vue
-
-```html
-<script setup>
-import { StkTable } from 'stk-table-vue'
-import { ref, useTemplateRef } from 'vue'
-const stkTableRef = ref<InstanceType<typeof StkTable>>();
-// or Vue 3.5 useTemplateRef
-const stkTableRef = useTemplateRef('stkTableRef');
-
-// highlight row
-stkTableRef.value.setHighlightDimRow([rowKey]，{
-  method: 'css'|'animation',// default animation。
-  className: 'custom-class-name', // method css。
-  keyframe: [{backgroundColor:'#aaa'}, {backgroundColor: '#222'}],//same as https://developer.mozilla.org/zh-CN/docs/Web/API/Web_Animations_API/Keyframe_Formats
-  duration: 2000,。
-});
- // highlight cell
-stkTableRef.value.setHighlightDimCell(rowKey, colDataIndex, {
-  method: 'css'|'animation',
-  className:'custom-class-name', // method css。
-  keyframe: [{backgroundColor:'#aaa'}, {backgroundColor: '#222'}], // method animation。
-  duration: 2000,。
-});
-
-const columns = [
-  {title: 'name', dataIndex: 'name'},
-  {title: 'age', dataIndex: 'age'},
-  {title: 'address', dataIndex: 'address'},
-];
-
-const dataSource = [
-  {id: 1, name: 'John', age: 32, address: 'New York'},
-  {id: 2, name: 'Jim', age: 42, address: 'London'},
-  {id: 3, name: 'Joe', age: 52, address: 'Tokyo'},
-  {id: 4, name: 'Jack', age: 62, address: 'Sydney'},
-  {id: 5, name: 'Jill', age: 72, address: 'Paris'},
-]
-
-</script>
-
-<template>
-    <StkTable ref='stkTableRef' row-key="id" :data-source="dataSource" :columns="columns"></StkTable>
-</template>
-
-```
-
-### Vue2.7 Usage
-[Vue2.7 Usage](https://ja-plus.github.io/stk-table-vue/main/start/vue2-usage.html)
-
-## API
-* [Props](https://ja-plus.github.io/stk-table-vue/main/api/table-props.html)
-
-* [Emits](https://ja-plus.github.io/stk-table-vue/main/api/emits.html)
-
-* [Slots](https://ja-plus.github.io/stk-table-vue/main/api/slots.html)
-
-* [Expose](https://ja-plus.github.io/stk-table-vue/main/api/expose.html)
-
-* [StkTableColumn: Define column type](https://ja-plus.github.io/stk-table-vue/main/api/stk-table-column.html)
-
-* [Highlight: setHighlightDimCell & setHighlightDimRow](https://ja-plus.github.io/stk-table-vue/main/api/expose.html#sethighlightdimcell)
-
-
-### Example
-```vue
-<template>
- <StkTable
-    ref="stkTable"
-    row-key="name"
-    v-model:columns="columns"
-    :style="{height:props.height}"
-    theme='dark'
-    height='200px'
-    bordered="h"
-    :row-height="28"
-    :show-overflow="false"
-    :show-header-overflow="false"
-    :sort-remote="false"
-    col-resizable
-    header-drag
-    virtual
-    virtual-x
-    no-data-full
-    col-resizable
-    auto-resize
-    fixed-col-shadow
-    :col-min-width="10"
-    :headless="false"
-    :data-source="dataSource"
-    @current-change="onCurrentChange"
-    @row-menu="onRowMenu"
-    @header-row-menu="onHeaderRowMenu"
-    @row-click="onRowClick"
-    @row-dblclick="onRowDblclick"
-    @sort-change="handleSortChange"
-    @cell-click="onCellClick"
-    @header-cell-click="onHeaderCellClick"
-    @scroll="onTableScroll"
-    @scroll-x="onTableScrollX"
-    @col-order-change="onColOrderChange"
-  />
-</template>
-<script setup>
-  import { h, defineComponent } from 'vue';
-  const columns = [
-    {
-      title: 'Name',
-      dataIndex: 'name',
-      fixed: 'left',
-      width: '200px',
-      headerClassName: 'my-th',
-      className: 'my-td',
-      sorter: true,
-      customHeaderCell: function FunctionalComponent(props){
-          return h(
-              'span',
-              { style: 'overflow:hidden;text-overflow:ellipsis;white-space:nowrap' },
-              props.col.title + '(render) text-overflow,',
-          );
-      },
-      customCell: defineComponent({
-        setup(){
-          //...
-          return () => <div></div> // vue jsx
-        }
-      })
-    },
-  ]
-</script>
-```
-
-## Compare
-Compare performance with other vue table [vue-table-compare](https://github.com/ja-plus/vue-table-compare)
-
-
-## Other
-* `$*$`
+<p align="center">
+    <a href="https://ja-plus.github.io/stk-table-vue/">
+        <img src="./docs-src/public/assets/logo.svg" width="152">
+    </a>
+    <h3 align='center'>Stk Table Vue</h3>
+    <p align="center">
+        <a href="https://www.npmjs.com/package/stk-table-vue"><img src="https://img.shields.io/npm/v/stk-table-vue"></a>
+        <a href="https://www.npmjs.com/package/stk-table-vue"><img src="https://img.shields.io/npm/dw/stk-table-vue"></a>
+        <a href="https://github.com/ja-plus/stk-table-vue/stargazers"><img src="https://img.shields.io/github/stars/ja-plus/stk-table-vue.svg"></a>
+        <a href="https://raw.githubusercontent.com/ja-plus/stk-table-vue/master/LICENSE"><img src="https://img.shields.io/npm/l/stk-table-vue"></a>
+        <a href="https://github.com/ja-plus/stk-table-vue"><img src="https://img.shields.io/npm/types/stk-table-vue"></a>
+    </p>
+</p>
+
+Stk Table Vue(Sticky Table) is a high-performance virtual list component based on Vue.
+
+Smooth performance with tens of thousands of rows
+
+Used for real-time data display, with data highlighting and dynamic effects.
+
+Support Vue3 and Vue2.7
+
+
+## Documentation
+### [Stk Table Vue Official](https://ja-plus.github.io/stk-table-vue/)
+
+
+## Repo: 
+- [Github](https://github.com/ja-plus/stk-table-vue)
+- [Gitee](https://gitee.com/japlus/stk-table-vue)
+
+## Demo
+[<span style="font-size: 16px;font-weight: bold;">Online Demo in stackblitz</span>](https://stackblitz.com/edit/vitejs-vite-ad91hh?file=src%2FDemo%2Findex.vue)
+
+## Usage
+> npm install stk-table-vue
+
+```html
+<script setup>
+import { StkTable } from 'stk-table-vue'
+import { ref, useTemplateRef } from 'vue'
+const stkTableRef = ref<InstanceType<typeof StkTable>>();
+// or Vue 3.5 useTemplateRef
+const stkTableRef = useTemplateRef('stkTableRef');
+
+// highlight row
+stkTableRef.value.setHighlightDimRow([rowKey]，{
+  method: 'css'|'animation',// default animation。
+  className: 'custom-class-name', // method css。
+  keyframe: [{backgroundColor:'#aaa'}, {backgroundColor: '#222'}],//same as https://developer.mozilla.org/zh-CN/docs/Web/API/Web_Animations_API/Keyframe_Formats
+  duration: 2000,。
+});
+ // highlight cell
+stkTableRef.value.setHighlightDimCell(rowKey, colDataIndex, {
+  method: 'css'|'animation',
+  className:'custom-class-name', // method css。
+  keyframe: [{backgroundColor:'#aaa'}, {backgroundColor: '#222'}], // method animation。
+  duration: 2000,。
+});
+
+const columns = [
+  {title: 'name', dataIndex: 'name'},
+  {title: 'age', dataIndex: 'age'},
+  {title: 'address', dataIndex: 'address'},
+];
+
+const dataSource = [
+  {id: 1, name: 'John', age: 32, address: 'New York'},
+  {id: 2, name: 'Jim', age: 42, address: 'London'},
+  {id: 3, name: 'Joe', age: 52, address: 'Tokyo'},
+  {id: 4, name: 'Jack', age: 62, address: 'Sydney'},
+  {id: 5, name: 'Jill', age: 72, address: 'Paris'},
+]
+
+</script>
+
+<template>
+    <StkTable ref='stkTableRef' row-key="id" :data-source="dataSource" :columns="columns"></StkTable>
+</template>
+
+```
+
+### Vue2.7 Usage
+[Vue2.7 Usage](https://ja-plus.github.io/stk-table-vue/main/start/vue2-usage.html)
+
+## API
+* [Props](https://ja-plus.github.io/stk-table-vue/main/api/table-props.html)
+
+* [Emits](https://ja-plus.github.io/stk-table-vue/main/api/emits.html)
+
+* [Slots](https://ja-plus.github.io/stk-table-vue/main/api/slots.html)
+
+* [Expose](https://ja-plus.github.io/stk-table-vue/main/api/expose.html)
+
+* [StkTableColumn: Define column type](https://ja-plus.github.io/stk-table-vue/main/api/stk-table-column.html)
+
+* [Highlight: setHighlightDimCell & setHighlightDimRow](https://ja-plus.github.io/stk-table-vue/main/api/expose.html#sethighlightdimcell)
+
+
+### Example
+```vue
+<template>
+ <StkTable
+    ref="stkTable"
+    row-key="name"
+    v-model:columns="columns"
+    :style="{height:props.height}"
+    theme='dark'
+    height='200px'
+    bordered="h"
+    :row-height="28"
+    :show-overflow="false"
+    :show-header-overflow="false"
+    :sort-remote="false"
+    col-resizable
+    header-drag
+    virtual
+    virtual-x
+    no-data-full
+    col-resizable
+    auto-resize
+    fixed-col-shadow
+    :col-min-width="10"
+    :headless="false"
+    :data-source="dataSource"
+    @current-change="onCurrentChange"
+    @row-menu="onRowMenu"
+    @header-row-menu="onHeaderRowMenu"
+    @row-click="onRowClick"
+    @row-dblclick="onRowDblclick"
+    @sort-change="handleSortChange"
+    @cell-click="onCellClick"
+    @header-cell-click="onHeaderCellClick"
+    @scroll="onTableScroll"
+    @scroll-x="onTableScrollX"
+    @col-order-change="onColOrderChange"
+  />
+</template>
+<script setup>
+  import { h, defineComponent } from 'vue';
+  const columns = [
+    {
+      title: 'Name',
+      dataIndex: 'name',
+      fixed: 'left',
+      width: '200px',
+      headerClassName: 'my-th',
+      className: 'my-td',
+      sorter: true,
+      customHeaderCell: function FunctionalComponent(props){
+          return h(
+              'span',
+              { style: 'overflow:hidden;text-overflow:ellipsis;white-space:nowrap' },
+              props.col.title + '(render) text-overflow,',
+          );
+      },
+      customCell: defineComponent({
+        setup(){
+          //...
+          return () => <div></div> // vue jsx
+        }
+      })
+    },
+  ]
+</script>
+```
+
+## Compare
+Compare performance with other vue table [vue-table-compare](https://github.com/ja-plus/vue-table-compare)
+
+
+## Other
+* `$*$`

package/lib/index-C40Rz-HL.js

@@ -1,6 +1,6 @@
 /**
  * name: stk-table-vue
- * version: v0.11.6
+ * version: v0.11.9
  * 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

@@ -418,13 +418,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     })) | (UniqKey | (PrivateRowDT & {
         children?: (PrivateRowDT & /*elided*/ any)[];
     }))[], option?: {
-        expand
-        /**
-         * props cannot be placed in a separate file. It will cause compilation errors with vue 2.7 compiler.
-         */
-        ? /**
-         * props cannot be placed in a separate file. It will cause compilation errors with vue 2.7 compiler.
-         */: boolean;
+        expand?: boolean;
     }) => void;
     /**
      * 获取拖选选中的单元格信息

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

@@ -254,12 +254,13 @@ export type SortConfig<T extends Record<string, any>> = {
     multiSortLimit?: number;
 };
 /** th td type */
-export declare const enum TagType {
-    TH = 0,
-    TD = 1,
+export declare const TagType: {
+    readonly TH: 0;
+    readonly TD: 1;
     /** tfoot */
-    TF = 2
-}
+    readonly TF: 2;
+};
+export type TagType = (typeof TagType)[keyof typeof TagType];
 export type HighlightConfig = {
     /** Duration of the highlight in seconds */
     duration?: number;

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

@@ -2,4 +2,4 @@ import { ComputedRef, Ref, ShallowRef } from 'vue';
 import { StkTableColumn, UniqKey } from './types';
 
 /** 列宽拖动 */
-export declare function useColResize<DT extends Record<string, any>>(props: any, emits: any, tableContainerRef: Ref<HTMLElement | undefined>, tableHeaderLast: ShallowRef<StkTableColumn<DT>[]>, colResizeIndicatorRef: Ref<HTMLElement | undefined>, colKeyGen: ComputedRef<(p: any) => UniqKey>, fixedCols: Ref<StkTableColumn<DT>[]>): readonly [ComputedRef<((col: StkTableColumn<DT>) => boolean) | (() => any)>, Ref<boolean, boolean>, (e: MouseEvent, col: StkTableColumn<DT>, leftHandle?: boolean) => void];
+export declare function useColResize<DT extends Record<string, any>>(props: any, emits: any, tableContainerRef: Ref<HTMLElement | undefined>, tableHeaderLast: ShallowRef<StkTableColumn<DT>[]>, colResizeIndicatorRef: Ref<HTMLElement | undefined>, colKeyGen: ComputedRef<(p: any) => UniqKey>, fixedCols: Ref<StkTableColumn<DT>[]>, onColWidthChange?: () => void): readonly [ComputedRef<((col: StkTableColumn<DT>) => boolean) | (() => any)>, Ref<boolean, boolean>, (e: MouseEvent, col: StkTableColumn<DT>, leftHandle?: boolean) => void];

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

@@ -1,4 +1,4 @@
-import { CSSProperties, ComputedRef, Ref } from 'vue';
+import { ComputedRef, Ref } from 'vue';
 import { StkTableColumn, TagType } from './types';
 import { VirtualScrollStore, VirtualScrollXStore } from './useVirtualScroll';
 
@@ -13,4 +13,4 @@ import { VirtualScrollStore, VirtualScrollXStore } from './useVirtualScroll';
  * @param virtualX_offsetRight
  * @returns
  */
-export declare function useFixedStyle<DT extends Record<string, any>>(props: any, isRelativeMode: Ref<boolean>, getFixedColPosition: ComputedRef<(col: StkTableColumn<DT>) => number>, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>, virtualX_on: Ref<boolean>, virtualX_offsetRight: Ref<number>): (tagType: TagType, col: StkTableColumn<DT>, depth?: number) => CSSProperties | null;
+export declare function useFixedStyle<DT extends Record<string, any>>(props: any, isRelativeMode: Ref<boolean>, getFixedColPosition: ComputedRef<(col: StkTableColumn<DT>) => number>, virtualScroll: Ref<VirtualScrollStore>, virtualScrollX: Ref<VirtualScrollXStore>, virtualX_on: Ref<boolean>, virtualX_offsetRight: Ref<number>): (tagType: TagType, col: StkTableColumn<DT>, depth?: number) => string;

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

@@ -75,4 +75,4 @@ export declare function useVirtualScroll(props: any, tableContainerRef: Ref<HTML
     endIndex: number;
     offsetLeft: number;
     scrollLeft: number;
-}>, import('vue').ComputedRef<any>, import('vue').ComputedRef<PrivateRowDT[]>, import('vue').ComputedRef<number>, import('vue').ComputedRef<any>, import('vue').ComputedRef<PrivateStkTableColumn<PrivateRowDT>[]>, import('vue').ComputedRef<number>, import('vue').ComputedRef<number>, (height?: number) => void, (height?: number) => void, () => void, (sTop?: number) => void, (sLeft?: number) => void, (rowKey: UniqKey, height?: number | null) => void, () => void];
+}>, import('vue').ComputedRef<any>, import('vue').ComputedRef<PrivateRowDT[]>, import('vue').ComputedRef<number>, import('vue').ComputedRef<any>, import('vue').ComputedRef<PrivateStkTableColumn<PrivateRowDT>[]>, import('vue').ComputedRef<number>, import('vue').ComputedRef<number>, (height?: number) => void, (height?: number) => void, () => void, (sTop?: number) => void, (sLeft?: number) => void, (rowKey: UniqKey, height?: number | null) => void, () => void, () => void];

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

@@ -68,3 +68,4 @@ export declare function throttle<T extends (...args: any[]) => any>(fn: T, delay
  * @returns A throttled function that executes on the next animation frame
  */
 export declare function rafThrottle<T extends (...args: any[]) => any>(fn: T): (...args: Parameters<T>) => void;
+export declare function debounce<T extends (...args: any[]) => any>(fn: T, delay: number): (...args: Parameters<T>) => void;