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

Learn about the difference by reading this guide on minimizing bundle size.

Props

The debounce time in milliseconds.

Type:number

Default:150

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

Type:func

Default:(values: string[]) => values.join(' ')

Signature:

function(values: Array) => string

values The new values passed to the quick filter model

Returns: The string to display in the text field

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

Type:func

Default:(searchText: string) => searchText .split(' ') .filter((word) => word !== '')

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Styles applied to the root element.

Rule name:root

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.