跳过到内容

GridFilterFormAPI

React GridFilterForm 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

import { GridFilterForm } from '@mui/x-data-grid/components';
// or
import { GridFilterForm } from '@mui/x-data-grid';
// or
import { GridFilterForm } from '@mui/x-data-grid-pro';
// or
import { GridFilterForm } from '@mui/x-data-grid-premium';

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

必需

当操作符、列字段或值更改时调用的回调。

类型:func

签名:
function(item: GridFilterItem) => void
必需

当逻辑操作符更改时调用的回调。

类型:func

签名:
function(operator: GridLogicOperator) => void
  • operator 新的逻辑操作符。
必需

当点击删除按钮时调用的回调。

类型:func

签名:
function(item: GridFilterItem) => void
必需

如果为 true，则渲染逻辑操作符字段。如果 showMultiFilterOperators 也为 true，则该字段将不可见。

类型:bool

必需

表示此表单的 GridFilterItem。

类型:{ field: string, id?: number
| string, operator: string, value?: any }

传递给列输入组件的 Props。

类型:any

默认值:{}

更改列选择器中选项的排序方式。如果未指定，则顺序从 columns prop 派生。

类型:'asc'
| 'desc'

传递给删除图标的 Props。

类型:any

默认值:{}

如果为 true，则禁用逻辑运算符字段，但仍会渲染它。

类型:bool

允许筛选在筛选表单中显示的列。

类型:func

签名:
function(args: FilterColumnsArgs) => void
  • args 网格的列和字段名称。

允许设置命令式焦点的 ref。它可以传递给 el

类型:func
| object

传递给逻辑运算符输入组件的 Props。

类型:any

默认值:{}

设置可用的逻辑运算符。

类型:Array<'and'
| 'or'>

默认值:[GridLogicOperator.And, GridLogicOperator.Or]

传递给操作符输入组件的 Props。

类型:any

默认值:{}

如果 filter 被禁用/只读，则为 true。例如：colDef.fiterable = false 但是在 filterModel 中传递。

类型:bool

默认值:false

如果为 true，则逻辑操作符字段可见。

类型:bool

传递给值输入组件的 Props。

类型:any

默认值:{}

ref 被转发到根元素。

源代码

如果您在此页面中没有找到所需信息，请考虑查看组件的实现以获取更多详细信息。