外观
KvTable
Element Plus 表格与分页的封装组件。
默认显示表头背景,设置 appearance.headerBackground: false 可关闭;headerCellStyle 仍具有最高优先级。应用可以通过 --kv-table-header-bg 定制背景色,未指定时跟随 Element Plus 的浅色填充变量,适配深浅主题。
实时预览
数据表格与分页
预览列配置、全局序号和受控分页效果。
Total 23Go to
- 1
- 2
- 3
Props
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
data | T[] | [] | 否 | 表格数据 |
rowKey | string | ((row: T) => string | number) | — | 是 | 行唯一键 |
loading | boolean | false | 否 | 加载状态 |
columns | ColumnOption<T>[] | [] | 否 | 列配置 |
pagination | KvTablePagination | — | 否 | 分页状态 |
paginationOptions | KvTablePaginationOptions | {} | 否 | 分页选项 |
appearance | Partial<TableAppearance> | {} | 否 | 表格外观 |
stripe | boolean | — | 否 | 斑马纹,覆盖 appearance |
border | boolean | — | 否 | 纵向边框,覆盖 appearance |
size | TableSize | — | 否 | 行密度,覆盖 appearance |
fit | boolean | true | 否 | 列宽是否自适应 |
showHeader | boolean | true | 否 | 是否显示表头 |
headerCellStyle | Record<string, string | number> | — | 否 | 表头单元格样式 |
height | string | number | — | 否 | 表格容器高度 |
emptyHeight | string | '320px' | 否 | 空状态高度 |
emptyText | string | '暂无数据' | 否 | 空状态文案 |
fullscreen | boolean | false | 否 | 是否全屏 |
Events
| 事件 | 参数 | 说明 |
|---|---|---|
pagination:size-change | number | 每页条数改变 |
pagination:current-change | number | 当前页改变 |
scroll-top | — | 翻页后滚动到顶部 |
Exposed
| 名称 | 类型 | 说明 |
|---|---|---|
scrollToTop | () => void | 滚动表格到顶部 |
ColumnOption
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
type | 'selection' | 'expand' | 'index' | 'globalIndex' | — | 否 | 特殊列类型 |
prop | string | — | 否 | 字段名 |
label | string | — | 否 | 列标题 |
width | string | number | — | 否 | 固定列宽 |
minWidth | string | number | — | 否 | 最小列宽 |
fixed | boolean | 'left' | 'right' | false | 否 | 固定列 |
sortable | boolean | 'custom' | false | 否 | 是否可排序 |
filters | unknown[] | — | 否 | 筛选选项 |
filterMethod | (value, row) => boolean | — | 否 | 筛选函数 |
filterPlacement | string | — | 否 | 筛选浮层位置 |
disabled | boolean | false | 否 | 是否禁止列设置中隐藏 |
visible | boolean | true | 否 | 是否显示 |
checked | boolean | true | 否 | 兼容字段,未设置 visible 时生效 |
formatter | (row: T) => unknown | — | 否 | 格式化函数 |
useSlot | boolean | false | 否 | 是否启用单元格插槽 |
slotName | string | prop | 否 | 单元格插槽名 |
useHeaderSlot | boolean | false | 否 | 是否启用表头插槽 |
headerSlotName | string | `${prop}-header` | 否 | 表头插槽名 |
示例代码
vue
<script setup>
import { ref } from 'vue'
import { KvTable } from '@kevairy/components'
const data = ref([
{ id: 1, name: 'Alice', age: 24 },
{ id: 2, name: 'Bob', age: 30 }
])
const columns = [
{ prop: 'id', label: 'ID', width: 80 },
{ prop: 'name', label: '姓名' },
{ prop: 'age', label: '年龄' }
]
const pagination = ref({ current: 1, size: 10, total: 2 })
const handleSizeChange = (size) => {
pagination.value.size = size
}
const handleCurrentChange = (current) => {
pagination.value.current = current
}
</script>
<template>
<KvTable
:data="data"
row-key="id"
:columns="columns"
:pagination="pagination"
@pagination:size-change="handleSizeChange"
@pagination:current-change="handleCurrentChange"
/>
</template>