stk-table-vue 0.11.6 → 0.11.7

package/README.md

@@ -1,172 +1,172 @@
-<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.
+>
+> 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
+* `$*$`

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

@@ -6,8 +6,11 @@
  * 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 } from "vue";
+import { defineComponent, ref, reactive, h, onMounted, onUnmounted, createElementBlock, openBlock, withModifiers, normalizeStyle, normalizeClass, createElementVNode, createVNode, nextTick } from "vue";
 import { StkTable as _sfc_main$1 } from "./stk-table-vue.js";
+const DROPDOWN_DEFAULT_WIDTH = 300;
+const DROPDOWN_DEFAULT_HEIGHT = 400;
+const PADDING = 6;
 const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "index",
   setup(__props, { expose: __expose }) {
@@ -21,8 +24,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
         className: "stk-filter-dropdown-checkbox",
         customCell: ({ row }) => h("input", {
           type: "checkbox",
-          checked: checkedTempValueSet.has(row.value),
-          onClick: (e) => e.preventDefault()
+          checked: checkedTempValueSet.has(row.value)
         })
       },
       { title: "", dataIndex: "label", customCell: ({ row }) => h("span", [row.label]) }
@@ -38,12 +40,51 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
       document.removeEventListener("click", handleClickOutside);
     });
     let onConfirmFn;
-    function show(pos, opt, onConfirm) {
+    function getDropdownSize() {
+      if (!dropdownEl.value) {
+        return [DROPDOWN_DEFAULT_WIDTH, DROPDOWN_DEFAULT_HEIGHT];
+      }
+      const rect = dropdownEl.value.getBoundingClientRect();
+      return [rect.width || DROPDOWN_DEFAULT_WIDTH, rect.height || DROPDOWN_DEFAULT_HEIGHT];
+    }
+    function calculatePosition(docPos) {
+      const scrollTop = window.pageYOffset || document.documentElement.scrollTop;
+      const scrollLeft = window.pageXOffset || document.documentElement.scrollLeft;
+      const viewportWidth = document.documentElement.clientWidth;
+      const viewportHeight = document.documentElement.clientHeight;
+      const [dropdownWidth, dropdownHeight] = getDropdownSize();
+      let finalX = docPos.x;
+      let finalY = docPos.y;
+      const relativeX = docPos.x - scrollLeft;
+      if (relativeX + dropdownWidth > viewportWidth - PADDING) {
+        finalX = viewportWidth - dropdownWidth - PADDING + scrollLeft;
+      }
+      const relativeY = docPos.y - scrollTop;
+      if (relativeY + dropdownHeight > viewportHeight - PADDING) {
+        const triggerHeight = docPos.height || 30;
+        if (relativeY - triggerHeight >= dropdownHeight + PADDING) {
+          finalY = docPos.y - triggerHeight - dropdownHeight - PADDING;
+        } else {
+          finalY = PADDING + scrollTop;
+        }
+      }
+      finalX = Math.max(PADDING + scrollLeft, finalX);
+      finalY = Math.max(PADDING + scrollTop, finalY);
+      return { x: finalX, y: finalY };
+    }
+    async function show(pos, opt, onConfirm) {
+      if (dropdownEl.value) {
+        dropdownEl.value.style.visibility = "hidden";
+      }
       visible.value = true;
-      position.value = pos;
       options.value = opt || [];
       initChecked();
       onConfirmFn = onConfirm;
+      await nextTick();
+      position.value = calculatePosition(pos);
+      if (dropdownEl.value) {
+        dropdownEl.value.style.visibility = "visible";
+      }
     }
     async function handleClickOutside(e) {
       var _a;
@@ -83,6 +124,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
     }
     function handleClear() {
       checkedTempValueSet.clear();
+      confirm();
     }
     __expose({ visible, show, hide, setTheme });
     return (_ctx, _cache) => {
@@ -90,7 +132,11 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
         ref_key: "dropdownEl",
         ref: dropdownEl,
         class: normalizeClass(["stk-filter-dropdown", [`stk-filter-dropdown--${theme.value}`]]),
-        style: normalizeStyle({ top: position.value.y + "px", left: position.value.x + "px", display: visible.value ? void 0 : "none" }),
+        style: normalizeStyle({
+          top: position.value.y + "px",
+          left: position.value.x + "px",
+          display: visible.value ? void 0 : "none"
+        }),
         onClick: _cache[0] || (_cache[0] = withModifiers(() => {
         }, ["stop"]))
       }, [

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

@@ -418,7 +418,13 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     })) | (UniqKey | (PrivateRowDT & {
         children?: (PrivateRowDT & /*elided*/ any)[];
     }))[], option?: {
-        expand?: boolean;
+        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;
     }) => void;
     /**
      * 获取拖选选中的单元格信息
@@ -745,6 +751,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         row: DT;
         col: StkTableColumn<DT> | null;
     }) => any) | undefined;
+    "onSort-change"?: ((col: StkTableColumn<any> | null, order: Order, data: any[], sortConfig: SortConfig<any>) => any) | undefined;
     "onTh-drag-start"?: ((dragStartKey: string) => any) | undefined;
     "onTh-drop"?: ((targetColKey: string) => any) | undefined;
     "onCol-order-change"?: ((dragStartKey: string, targetColKey: string) => any) | undefined;
@@ -754,7 +761,6 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         row: DT;
         col: StkTableColumn<DT> | null;
     }) => any) | undefined;
-    "onSort-change"?: ((col: StkTableColumn<any> | null, order: Order, data: any[], sortConfig: SortConfig<any>) => any) | undefined;
     "onRow-click"?: ((ev: MouseEvent, row: any, data: {
         rowIndex: number;
     }) => any) | undefined;

package/lib/src/StkTable/components/Filter/Dropdown/index.d.ts

@@ -3,7 +3,8 @@ export declare function getDropdownIns(): Promise<import('vue').CreateComponentP
     show: (pos: {
         x: number;
         y: number;
-    }, opt: import('../types').FilterOption[], onConfirm: (values: import('../types').FilterOption["value"][]) => void) => void;
+        height?: number;
+    }, opt: import('../types').FilterOption[], onConfirm: (values: import('../types').FilterOption["value"][]) => void) => Promise<void>;
     hide: () => void;
     setTheme: (t: "light" | "dark") => void;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {}, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
@@ -18,7 +19,8 @@ export declare function getDropdownIns(): Promise<import('vue').CreateComponentP
     show: (pos: {
         x: number;
         y: number;
-    }, opt: import('../types').FilterOption[], onConfirm: (values: import('../types').FilterOption["value"][]) => void) => void;
+        height?: number;
+    }, opt: import('../types').FilterOption[], onConfirm: (values: import('../types').FilterOption["value"][]) => void) => Promise<void>;
     hide: () => void;
     setTheme: (t: "light" | "dark") => void;
 }, {}, {}, {}, {}>>;

package/lib/src/StkTable/components/Filter/Dropdown/index.vue.d.ts

@@ -3,7 +3,8 @@ import { FilterOption } from '../types';
 declare function show(pos: {
     x: number;
     y: number;
-}, opt: FilterOption[], onConfirm: (values: FilterOption['value'][]) => void): void;
+    height?: number;
+}, opt: FilterOption[], onConfirm: (values: FilterOption['value'][]) => void): Promise<void>;
 declare function hide(): void;
 declare function setTheme(t: 'light' | 'dark'): void;
 declare const _default: import('vue').DefineComponent<{}, {

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

@@ -0,0 +1 @@
+export declare const MY_FN_NAME = "stkName";

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

@@ -1 +1 @@
-export { useAreaSelection } from './useAreaSelection';
+export { useAreaSelection, useAreaSelectionName } from './useAreaSelection';

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

@@ -29,3 +29,4 @@ export declare function useAreaSelection<DT extends Record<string, any>>(props:
     copy: () => string;
     onMD: (e: MouseEvent) => void;
 };
+export declare const useAreaSelectionName = "useAreaSelection";

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

@@ -1,4 +1,8 @@
-type OnDemandFeature = {};
+import { useAreaSelection, useAreaSelectionName } from './features';
+
+type OnDemandFeature = {
+    [useAreaSelectionName]: typeof useAreaSelection<any>;
+};
 export declare const ON_DEMAND_FEATURE: OnDemandFeature;
 type Feature = OnDemandFeature[keyof OnDemandFeature];
 export declare function registerFeature(feature: Feature | Feature[]): void;

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

@@ -325,6 +325,7 @@ export type AreaSelectionRange = {
 };
 /** 单元格选区配置 */
 export type AreaSelectionConfig<T extends Record<string, any> = any> = {
+    /** default: true */
     enabled?: boolean;
     /**
      * 复制时的单元格文本格式化回调。