Skip to content

SearchForm 搜索表单

提供了便捷的搜索表单配置和操作。支持动态搜索项、折叠展开、自定义渲染等功能,通常和DataTable组件组合用于常用的数据分页查询功能。

基础用法

基础的搜索表单配置展示。

折叠展开

自定义按钮

自定义表单项

联动搜索

API

SearchForm 属性

属性名说明类型默认值
fields搜索字段配置数组array[]
is-search-loading是否正在搜索加载booleanfalse
is-show-collapse是否显示折叠按钮booleantrue
is-show-search-button是否显示搜索按钮booleantrue
is-show-reset-button是否显示重置按钮booleantrue
label-width字段标签的宽度number120
input-width字段宽度number200
label-suffix字段标签的后缀string
buttons按钮列表array[]

SearchFormField 配置

属性名说明类型默认值
name required字段名称string-
trim是否去除空格,只对input类型有效booleanfalse
label字段标签string-
slot自定义插槽名称string-
value字段的值any-
default-value当前字段的默认值any-
label-width字段标签的宽度number-
input-width字段宽度number-
is-show是否显示booleantrue
...其他属性,具体见search-field文档--

SearchFormButton 配置

属性名说明类型默认值
handle-code按钮操作CODE作为唯一标识string-
contents按钮文本string-
slot自定义插槽名称(如有值其他选项无效)string-
is-show是否显示booleantrue
click按钮点击事件Function-
...其他属性配置选项,具体见(element-plus button文档--

SearchForm 事件

事件名说明参数
fieldsChange表单字段变化事件Function
search点击搜索按钮时触发Function
change点击重置按钮时触发Function
collapseStatusChange折叠状态变化事件Function

SearchForm 方法

方法名说明参数
changeFormFields修改当前form字段的属性Function
getValue获取当前搜索表单的数据对象Function

SearchForm 插槽

插槽名说明作用域
[field.slot]自定义搜索项内容object

注意事项

  1. 搜索字段的 name 属性必须唯一
  2. 自定义搜索项需要自行处理数据绑定
  3. 折叠展开功能需要合理设置显示行数
  4. 建议搜索项不要过多,影响用户体验
  5. 可以通过自定义按钮区域实现更多操作

基于 MIT 许可发布