Skip to content

TableForm

查询列表

使用

Props

NameDescriptionTypeOptionsDefault
v-model表单值object--
form-props请参考 NForm 属性object--
table-props请参考 NTable 属性object--
add是否显示 add 按钮boolean--
add-propsadd 按钮属性object--
enter-query输入框回车是否触发查询事件boolean-true
outside-height用户计算表格高度。除开 ProTableForm 之外的其它元素高度,设置了表格高度或者设置成 0 则无效,number-0

支持Form 属性Dialog 属性

Events

NameDescriptionParameters
query查询按钮被点击后触发,使用done()函数来关闭loading状态done, isValid, invalidFields
reset重置按钮被点击后触发-
add新增按钮被点击后触发-
size-changepageSize 改变时会触发每页条数
current-changecurrentPage 改变时会触发当前页
prev-click用户点击上一页按钮改变当前页后触发当前页
next-click用户点击下一页按钮改变当前页后触发当前页
save用户点击保存自定义列的时候触发,其中 done 函数可以关闭 loading 状态和弹窗,如果传入 false 只关闭 loading,不关闭弹窗。拿到 columns 属性之后你需要重置旧的属性值以达到改变列的状态function(columns, done)

Methods

NameDescriptionParameters
resetFields对整个表单进行重置,将所有字段值重置为初始值并移除校验结果-
clearSelection用于多选表格,清空用户的选择
toggleRowSelection用于多选表格,切换某一行的选中状态, 如果使用了第二个参数,则是设置这一行选中与否(selected 为 true 则选中)row, selected
toggleAllSelection用于多选表格,切换全选和全不选
toggleRowExpansion用于可扩展的表格或树表格,如果某行被扩展,则切换。 使用第二个参数,您可以直接设置该行应该被扩展或折叠。row, expanded
setCurrentRow用于单选表格,设定某一行为选中行, 如果调用时不加参数,则会取消目前高亮行的选中状态。row
clearSort用于清空排序条件,数据会恢复成未排序的状态
clearFilter传入由columnKey 组成的数组以清除指定列的过滤条件。 不传入参数时用于清空所有过滤条件,数据会恢复成未过滤的状态columnKeys
doLayout对 Table 进行重新布局。 当 Table 或其祖先元素由隐藏切换为显示时,可能需要调用此方法
sort手动对 Table 进行排序。 参数 prop 属性指定排序列,order 指定排序顺序。prop: string, order: string
doQuery手动触发query事件-

Slots

NameDescription
-按钮节点之前的内容
form-before字段开始之前的内容
form-after按钮节点之后的内容
action-before在关闭按钮之前的内容
action-after新增按钮之后的内容,如果开启更多按钮则在更多按钮前面
[prop]当前这项的 Form Item 的内容,参数为{ item, value, setValue }
[prop]-label当前这项的标签文本的内容,参数为 { item }
[prop]-error当前这项的自定义表单校验信息的显示方式,参数为 { error, item }
title自定义弹窗标题

提示

Dialog 组件插槽除了title以外其它无效

[prop] 为 fields 中定义的 prop

TypeScript 定义

ts
export declare const defineTableFormMethod: () => Ref<TableFormExpose>

粤ICP备2022017444号