SearchForm 搜索表单
提供了便捷的搜索表单配置和操作。支持动态搜索项、折叠展开、自定义渲染等功能,通常和DataTable
组件组合用于常用的数据分页查询功能。
基础用法
基础的搜索表单配置展示。
折叠展开
自定义按钮
自定义表单项
联动搜索
API
SearchForm 属性
属性名 | 说明 | 类型 | 默认值 |
---|---|---|---|
fields | 搜索字段配置数组 | array | [] |
is-search-loading | 是否正在搜索加载 | boolean | false |
is-show-collapse | 是否显示折叠按钮 | boolean | true |
is-show-search-button | 是否显示搜索按钮 | boolean | true |
is-show-reset-button | 是否显示重置按钮 | boolean | true |
label-width | 字段标签的宽度 | number | 120 |
input-width | 字段宽度 | number | 200 |
label-suffix | 字段标签的后缀 | string | : |
buttons | 按钮列表 | array | [] |
SearchFormField 配置
属性名 | 说明 | 类型 | 默认值 |
---|---|---|---|
name required | 字段名称 | string | - |
trim | 是否去除空格,只对input类型有效 | boolean | false |
label | 字段标签 | string | - |
slot | 自定义插槽名称 | string | - |
value | 字段的值 | any | - |
default-value | 当前字段的默认值 | any | - |
label-width | 字段标签的宽度 | number | - |
input-width | 字段宽度 | number | - |
is-show | 是否显示 | boolean | true |
... | 其他属性,具体见search-field文档 | - | - |
SearchFormButton 配置
属性名 | 说明 | 类型 | 默认值 |
---|---|---|---|
handle-code | 按钮操作CODE作为唯一标识 | string | - |
contents | 按钮文本 | string | - |
slot | 自定义插槽名称(如有值其他选项无效) | string | - |
is-show | 是否显示 | boolean | true |
click | 按钮点击事件 | Function | - |
... | 其他属性配置选项,具体见(element-plus button文档) | - | - |
SearchForm 事件
事件名 | 说明 | 参数 |
---|---|---|
fieldsChange | 表单字段变化事件 | Function |
search | 点击搜索按钮时触发 | Function |
change | 点击重置按钮时触发 | Function |
collapseStatusChange | 折叠状态变化事件 | Function |
SearchForm 方法
方法名 | 说明 | 参数 |
---|---|---|
changeFormFields | 修改当前form字段的属性 | Function |
getValue | 获取当前搜索表单的数据对象 | Function |
SearchForm 插槽
插槽名 | 说明 | 作用域 |
---|---|---|
[field.slot] | 自定义搜索项内容 | object |
注意事项
- 搜索字段的 name 属性必须唯一
- 自定义搜索项需要自行处理数据绑定
- 折叠展开功能需要合理设置显示行数
- 建议搜索项不要过多,影响用户体验
- 可以通过自定义按钮区域实现更多操作