Skip to content

ProQueryForm

ProQueryForm 是一个基于 ProBaseForm 的高级查询表单组件,支持自定义工具栏(如搜索、重置按钮),支持表单字段动态折叠与展开功能,适用于复杂的查询条件表单场景。

基础用法

请输入姓名
Please Input
请选择地址
{}
Default
expand codecollapse code

属性 (Props)

属性名类型默认值描述
columnsProQueryFormColumn[][]表单字段配置,定义查询表单的结构。继承自 ProBaseFormcolumns 属性,支持所有基础字段配置。注: 不支持 span 设置
toolbarProQueryFormToolBar{ justify: 'end', search: true, searchText: '搜索', reset: true, resetText: '重置' }查询表单工具栏配置,定义搜索、重置按钮的行为和显示。
showNumbernumber3可见字段数,表示展开时最多显示的表单字段数量。其余字段会被折叠,点击展开按钮后显示全部字段。
labelPlacement'left' | 'top''left'表单标签的位置,left 表示左对齐,top 表示顶部对齐。
defaultCollapsedbooleantrue是否默认折叠表单字段。
search() => voidundefined搜索按钮点击时触发的回调函数。
reset() => voidundefined重置按钮点击时触发的回调函数。

toolbar 配置

toolbar 对象用于配置工具栏,包含搜索和重置按钮的显示、文案以及样式。

属性名类型默认值描述
justify'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly''end'按钮在工具栏中的对齐方式。
searchbooleantrue是否显示搜索按钮。
searchTextstring'搜索'搜索按钮的文本。
searchPropsButtonProps(Naive UI 按钮属性){ type: 'primary' }搜索按钮的属性,支持 Naive UI 按钮的所有属性。
resetbooleantrue是否显示重置按钮。
resetTextstring'重置'重置按钮的文本。
resetPropsButtonProps(Naive UI 按钮属性){}重置按钮的属性,支持 Naive UI 按钮的所有属性。

事件 (Emits)

事件名参数描述
search点击搜索按钮时触发的事件,表示用户执行搜索操作。
reset点击重置按钮时触发的事件,表示用户执行重置表单操作。

插槽 (Slots)

插槽名称参数描述
toolbar-自定义工具栏内容。如果提供了该插槽,将完全替换默认的搜索、重置和展开/收起按钮。
footer{ overflow: boolean } - 表单是否处于折叠状态。自定义表单底部内容,默认包含工具栏。
default-表单的主体内容,继承自 ProBaseForm,用于自定义表单字段的布局与显示。

插槽使用示例:

vue

<ProQueryForm>
  <template #toolbar>
    <n-button type="info">Custom Search</n-button>
    <n-button type="error">Custom Reset</n-button>
  </template>
</ProQueryForm>

方法 (Expose)

方法名参数描述
resetFields-重置表单字段值为空字符串。