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 '@mui/x-data-grid-premium';
// or
import { GridToolbarQuickFilter } from '@mui/x-data-grid-pro';
// or
import { GridToolbarQuickFilter } from '@mui/x-data-grid';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiDataGrid can be used when providing default props or style overrides in the theme.

Props

Name	Type	Default	Description
debounceMs	number	500	The debounce time in milliseconds.
quickFilterFormatter	func		Function responsible for formatting values of quick filter in a string when the model is modified Signature: `function(values: Array<any>) => string` values: The new values passed to the quick filter model returns (string): The string to display in the text field
quickFilterParser	func		Function responsible for parsing text input in an array of independent values for quick filtering. Signature: `function(input: string) => Array<any>` input: The value entered by the user returns (Array): The array of value on which quick filter is applied

The ref is forwarded to the root element.

CSS

Rule name	Global class	Description
root	.MuiDataGrid-root	Styles applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.