---
title: 筛选
title_en: Filter
name: filter
publishDate: 2018-4-23
category: 1
order: 2
description: Filter组件的描述
---

 何时使用

针对单一主体有多维度查询条件时使用，页面列表和弹窗内均可使用

 参数

| 名称 | 描述       | 默认值     |
| ---- | ---------- | -------- |
| operation    | 和查询与重置并列的操作        | () => null |
| className    | filter class | 自定义 filter classname  |
| changeHistory   | 是否需要将筛选状态同步到 url, 区分弹窗、页面和页面内多筛选场景       | true |
| onSubmit  | 查询回调 | () => null
| onReset  | 重置回调 | () => false
| compKey  | 组件的 key, 开启本地储存时，需要保证页面唯一 | 'pk-filter'
| custom  | 是否开启本地储存 | true

 api

通过 ref 调用 filter 方法

| 名称 | 描述       | 默认值     |
| ---- | ---------- | -------- |
| getFields    | 获取所有值        | return Object |
| setFields    | 手动写 filter 输入项的值 | function(<Object>)  |