QuickFilter API

API reference docs for the React QuickFilter 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:

Data Grid - Quick Filter

Import

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

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

The top level Quick Filter component that provides context to child components. It does not render any DOM elements.

Props

debounceMs

The debounce time in milliseconds.

Type:number

Default:150

formatter

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

parser

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.

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.