Skip to content
Edit this page

GridToolbarQuickFilter API

API reference docs for the React GridToolbarQuickFilter component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import GridToolbarQuickFilter from '/packages/grid/x-data-grid/src/components/toolbar/GridToolbarQuickFilter.tsx/GridToolbarQuickFilter';
// or
import { GridToolbarQuickFilter } from '/packages/grid/x-data-grid/src/components/toolbar/GridToolbarQuickFilter.tsx';
Learn about the difference by reading this guide on minimizing bundle size.

Props

debounceMs

The debounce time in milliseconds.

Type:

number

Default:

500
quickFilterFormatter

Function responsible for formatting values of quick filter in a string when the model is modified

Type:

func

Signature:

function(values: Array) => string
  • values The new values passed to the quick filter model

Returns: The string to display in the text field

quickFilterParser

Function responsible for parsing text input in an array of independent values for quick filtering.

Type:

func

Signature:

function(input: string) => Array
  • input The value entered by the user

Returns: The array of value on which quick filter is applied

The ref is forwarded to the root element.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiDataGrid-rootroot

Styles applied to the root element.

You can override the style of the component using one of these customization options: