Skip to content

KvTableToolbar ​

表格工具栏组件,提供搜索显隐、刷新、密度、全屏、列设置和外观设置。

实时预览 ​

表格工具栏

可直接切换搜索栏、密度、列显隐和表格外观。

实时渲染
用户列表
搜索栏:显示;密度:default;刷新:0 次

Props ​

属性类型默认值必填说明
showStripebooleantrue否是否显示斑马纹开关
showBorderbooleantrue否是否显示边框开关
showHeaderBackgroundbooleantrue否是否显示表头背景开关
toolbarOptionsPartial<KvTableToolbarOptions>{}否工具按钮显隐配置,合并默认值后生效
layoutstring—否旧版兼容属性,建议改用 toolbarOptions
loadingbooleanfalse否刷新按钮加载状态
messagesPartial<KevairyComponentMessages>{}否组件文案覆盖

KvTableToolbarOptions 默认值:

按钮属性默认显示
搜索栏显隐search否
刷新refresh是
表格密度density否
全屏fullscreen是
列设置columns否
外观设置settings否

v-model ​

名称类型默认值说明
columnsColumnOption<T>[][]完整列配置
showSearchBarbooleantrue是否显示搜索栏
fullscreenbooleanfalse是否全屏
appearanceTableAppearance见下表表格外观

TableAppearance:

属性类型默认值说明
size'small' | 'default' | 'large''default'行密度
stripebooleanfalse斑马纹
borderbooleanfalse纵向边框
headerBackgroundbooleantrue表头背景

Events ​

事件参数说明
refresh—点击刷新按钮时触发

Slots ​

插槽说明
left工具栏左侧内容
right工具栏右侧内容

插槽按钮间距规范 ​

工具栏内置按钮和插槽按钮统一使用 8px 间距,包括最后一个内置按钮与第一个业务按钮之间的间距。left / right 插槽优先直接插入按钮,组件通过 flex gap: 8px 排列,并清除直接子级 ElButton 的默认左外边距,避免与 gap 叠加。换行时纵向间距同为 8px。

页面不要额外添加按钮 margin、space-x-* 或 ElSpace。确需包装分组时,包装层必须同样使用 flex 布局和 gap: 8px,并清除组内按钮默认外边距,保证组内、组间和内置按钮之间的间距一致。

此规范同样适用于 KvSearchTable、KvSearchTablePage 转发的 toolbar-left / toolbar-right 插槽:

vue
<template #toolbar-right>
  <ElButton type="primary" @click="create">新增字典</ElButton>
  <ElButton @click="manageVersions">版本管理</ElButton>
  <ElButton @click="createSnapshot">创建版本快照</ElButton>
</template>

示例代码 ​

vue
<script setup>
  import { ref } from 'vue'
  import { KvTableToolbar } from '@kevairy/components'

  const columns = ref([
    { prop: 'name', label: '姓名', visible: true },
    { prop: 'age', label: '年龄', visible: true }
  ])

  const showSearchBar = ref(true)
  const fullscreen = ref(false)
  const appearance = ref({ size: 'default', stripe: false, border: false, headerBackground: false })

  const handleRefresh = () => {
    console.log('refresh')
  }
</script>

<template>
  <KvTableToolbar
    v-model:columns="columns"
    v-model:show-search-bar="showSearchBar"
    v-model:fullscreen="fullscreen"
    v-model:appearance="appearance"
    :toolbar-options="{ columns: true, density: true }"
    @refresh="handleRefresh"
  />
</template>