Skip to contentSkip to content

QuickFilterControl API

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

Demos

Import

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

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



A component that takes user input and filters row data. It renders the baseTextField slot.

Props

The autocomplete attribute of the input element.

Type:string


If true, the input element is focused during the first mount.

Type:bool


Override or extend the styles applied to the component.

Type:func
| string


The color of the text field.

Type:'error'
| 'primary'


If true, the text field is disabled.

Type:bool


If true, the text field is displayed in an error state.

Type:bool


If true, the text field takes up the full width of its container.

Type:bool


The helper text displayed below the input.

Type:string


The id of the input element.

Type:string


A ref to the input element.

Type:func
| { current?: object }


The label of the text field.

Type:node


If true, a textarea element is rendered instead of an input.

Type:bool


The short hint displayed in the input before the user enters a value.

Type:string


A function to customize rendering of the component.

Type:element
| func


The ARIA role of the root element.

Type:string


The size of the text field.

Type:'medium'
| 'small'


The props used for each slot inside.

Type:object


The tabIndex of the input element.

Type:number


The type of the input element.

Type:string


The value of the input element.

Type:string


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.