README.md

Shene Table

Shene Table - A Vue.js 3 Table UI library

在线文档 在线体验

• 💪 Vue 3 组合式 API
• 🔥 使用 TypeScript 开发，提供完整的类型定义文件

概述

Shene Table 是基于 Vue3 的复杂表格组件，该组件致力于解决大数据渲染等复杂高频问题。 使用该组件可以流畅滚动 10 万行、10 万列的数据，你不必担心页面卡顿造成等问题，进而影响业务进展。

该组件不依赖任何组件库，所以说你可以使用在任何组件库中，当然必须是基于 Vue3 的。

Shene Table 默认使用虚拟滚动提升渲染速度，树形数据、展开内容、嵌套子表格、行列合并、自动行高、横向、纵向、吸顶、固定头、固定列等等一切都支持虚拟滚动。

Shene Table 设计风格与 Ant Design 有些类似，当然你不必担心 在 Element Plus 中样式不统一的问题，因为组件内的所有样式全部通过 CSS 变量的方式设置的，你可以非常简单的覆盖样式而达到你想要的效果。

环境支持

由于 Vue 3 不再支持 IE11，Shene Table 也不再支持 IE 浏览器。

Edge ≥ 79	Firefox ≥ 78	Chrome ≥ 64	Safari ≥ 12

安装

我们建议您使用包管理器 (npm, yarn, pnpm) 安装 Shene Table

# 选择一个你喜欢的包管理器

# npm
$ npm install @shene/table --save

# yarn
$ yarn add @shene/table

# pnpm
$ pnpm install @shene/table

全局注册

我们建议直接在入口处导入进行全局注册，组件内部会自动注册子组件（STableProvider、STableColumn、 STableColumnGroup、 STableSummary、 STableSummaryRow、 STableSummaryCell）：

import { createApp } from 'vue'
import STable from '@shene/table'
import App from './App.vue'
import '@shene/table/dist/index.css'

const app = createApp(App)

app.use(STable)
app.mount('#app')

在模板中的对应使用的组件名称为下划线，如：STable 对应 s-table 等等：

<template>
	<s-table :columns="columns" :data-source="dataSource" :pagination="false" />
</template>

<script setup lang="tsx">
import { ref } from 'vue'
import type { STableColumnsType } from '@shene/table'

interface DataType {
	key: string
	name: string
	age: number
	sex: string
	address: string
}

const columns: STableColumnsType<DataType> = [
	{
		title: '姓名',
		dataIndex: 'name',
		key: 'name',
		width: 120
	},
	{
		title: '年龄',
		dataIndex: 'age',
		key: 'age',
		width: 100
	},
	{
		title: '性别',
		dataIndex: 'sex',
		key: 'sex',
		width: 100
	},
	{
		title: '地址',
		dataIndex: 'address',
		key: 'address'
	},
	{
		title: '操作',
		key: 'action',
		width: 120,
		customRender: () => (
			<div>
				<a style="margin-right: 10px">编辑</a>
				<a>删除</a>
			</div>
		)
	}
]

const data: DataType[] = []
for (let i = 0; i < 5; i++) {
	data.push({
		key: i.toString(),
		name: ['张三', '李四', '王五', '马六'][i % 4],
		age: [18, 30, 26, 45][i % 4],
		sex: ['男', '女'][i % 2],
		address: ['北京', '上海', '天津', '重庆'][i % 4] + '市某某区某某大街520号'
	})
}

const dataSource = ref(data)
</script>