# stk-table-vue

**Repository Path**: japlus/stk-table-vue

## Basic Information

- **Project Name**: stk-table-vue
- **Description**: virtual scroll table vue
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 3
- **Created**: 2023-12-07
- **Last Updated**: 2026-09-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Web, Vue, table

## README

<p align="center">
    <a href="https://ja-plus.github.io/stk-table-vue/">
        <img src="https://raw.githubusercontent.com/ja-plus/stk-table-vue/master/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 scrolling table component based on Vue 3 / Vue 2.7.

Smooth performance with tens of thousands of rows. Designed for real-time data display with built-in highlighting and animation effects.

- Vue 3 & Vue 2.7 support
- Virtual scrolling (X & Y axis)
- CSS `sticky` based fixed columns & fixed header
- Multi-level header with horizontal virtual scroll
- Tree table & expandable rows
- Area selection with keyboard navigation
- Cell highlighting with Animation API
- Built-in custom cells: Filter, Editable, Checkbox, Number, Change
- Column resize, header drag, row drag
- Merge cells (virtual mode, huge rowspan / colspan supported)
- Custom scrollbar
- Sortable & filterable
- Theme support (dark / light)
- CSS variables for easy customization
- Based on native `<table>` element
- Zero third-party runtime dependencies


## Documentation
### [Stk Table Vue Official](https://ja-plus.github.io/stk-table-vue/)
### [Stk Table React Official](https://ja-plus.github.io/stk-table-react/)
### [Stk Table Svelte Official](https://ja-plus.github.io/stk-table-svelte/)
### [Stk Table Solid Official](https://ja-plus.github.io/stk-table-solid/)

## 🤖 For AI assistants

如果你是通过 AI 编码助手（Claude Code / Cursor / Copilot / Qoder 等）接入本库：

1. **先读 [`llms.txt`](./llms.txt)**（已随 npm 包发布，位于 `node_modules/stk-table-vue/llms.txt`）—— props / 列配置 / emits / slots / 实例方法速查，外加「约束与坑」与自检清单，其版本号与本包严格一致。
2. 不要靠阅读 `src/StkTable/StkTable.vue` 或 `lib/*.js` 反推 API。
3. 需要更细的说明时，抓取[文档站](https://ja-plus.github.io/stk-table-vue/)对应**单页**的 `.md` 镜像（`llms.txt` 末尾有主题 → URL 索引）。请勿抓取 `llms-full.txt`（全站合并，约 590KB）。
4. 类型权威定义：`lib/src/StkTable/types/index.d.ts`（含中文 JSDoc，hover 即可看到）。

想让 AI 助手无需提醒就能用上这份速查表，在你项目的 `AGENTS.md`（或 `.cursor/rules/`、`.claude/skills/`）加一行指针即可：

```markdown
本项目使用 stk-table-vue。写表格代码前先读 node_modules/stk-table-vue/llms.txt，不要从源码反推 API。
```


## 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', // for 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', // for method 'css'
  keyframe: [{ backgroundColor: '#aaa' }, { backgroundColor: '#222' }], // for 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-virtual-table-benchmark](https://github.com/ja-plus/vue-virtual-table-benchmark)

[Benchmark Result Page](https://ja-plus.github.io/vue-virtual-table-benchmark/perf-report.html)

## Changelog
[CHANGELOG](CHANGELOG.md)


## License
[MIT](LICENSE)