跳到主要內容

GridFilterFormAPI

React GridFilterForm 組件的 API 參考文件。 了解此匯出模組的 props、CSS 和其他 API。

示範

Import

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';

了解差異，請閱讀本指南，了解如何最小化套件大小。

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 Grid 的欄位和欄位名稱。

允許設定命令式焦點的 ref。 它可以傳遞到 el

類型：func
| object

傳遞至邏輯運算子輸入組件的 Props。

類型：any

預設值：{}

設定可用的邏輯運算子。

類型：Array<'and'
| 'or'>

預設值：[GridLogicOperator.And, GridLogicOperator.Or]

傳遞至運算子輸入組件的 Props。

類型：any

預設值：{}

如果篩選器已停用/唯讀，則為 true。 例如： colDef.fiterable = false 但在 filterModel 中傳遞

類型：bool

預設值：false

如果為 true，則邏輯運算子欄位為可見。

類型：bool

傳遞至值輸入組件的 Props。

類型：any

預設值：{}

ref 轉發到根元素。

原始碼

如果您在此頁面中找不到資訊，請考慮查看組件的實作以獲取更多詳細資訊。