Skip to content

KvTable ​

Element Plus 表格与分页的封装组件。

默认显示表头背景,设置 appearance.headerBackground: false 可关闭;headerCellStyle 仍具有最高优先级。应用可以通过 --kv-table-header-bg 定制背景色,未指定时跟随 Element Plus 的浅色填充变量,适配深浅主题。

实时预览 ​

数据表格与分页

预览列配置、全局序号和受控分页效果。

实时渲染

Props ​

属性类型默认值必填说明
dataT[][]否表格数据
rowKeystring | ((row: T) => string | number)—是行唯一键
loadingbooleanfalse否加载状态
columnsColumnOption<T>[][]否列配置
paginationKvTablePagination—否分页状态
paginationOptionsKvTablePaginationOptions{}否分页选项
appearancePartial<TableAppearance>{}否表格外观
stripeboolean—否斑马纹,覆盖 appearance
borderboolean—否纵向边框,覆盖 appearance
sizeTableSize—否行密度,覆盖 appearance
fitbooleantrue否列宽是否自适应
showHeaderbooleantrue否是否显示表头
headerCellStyleRecord<string, string | number>—否表头单元格样式
heightstring | number—否表格容器高度
emptyHeightstring'320px'否空状态高度
emptyTextstring'暂无数据'否空状态文案
fullscreenbooleanfalse否是否全屏

Events ​

事件参数说明
pagination:size-changenumber每页条数改变
pagination:current-changenumber当前页改变
scroll-top—翻页后滚动到顶部

Exposed ​

名称类型说明
scrollToTop() => void滚动表格到顶部

ColumnOption ​

属性类型默认值必填说明
type'selection' | 'expand' | 'index' | 'globalIndex'—否特殊列类型
propstring—否字段名
labelstring—否列标题
widthstring | number—否固定列宽
minWidthstring | number—否最小列宽
fixedboolean | 'left' | 'right'false否固定列
sortableboolean | 'custom'false否是否可排序
filtersunknown[]—否筛选选项
filterMethod(value, row) => boolean—否筛选函数
filterPlacementstring—否筛选浮层位置
disabledbooleanfalse否是否禁止列设置中隐藏
visiblebooleantrue否是否显示
checkedbooleantrue否兼容字段,未设置 visible 时生效
formatter(row: T) => unknown—否格式化函数
useSlotbooleanfalse否是否启用单元格插槽
slotNamestringprop否单元格插槽名
useHeaderSlotbooleanfalse否是否启用表头插槽
headerSlotNamestring`${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>