UNPKG

@mui/x-data-grid

Version:

The community edition of the data grid component (MUI X).

36 lines (35 loc) 1.48 kB
import * as React from 'react'; import { TextFieldProps } from '@mui/material/TextField'; import { GridFilterModel } from '../../models/gridFilterModel'; export type GridToolbarQuickFilterProps = TextFieldProps & { /** * Function responsible for parsing text input in an array of independent values for quick filtering. * @param {string} input The value entered by the user * @returns {any[]} The array of value on which quick filter is applied */ quickFilterParser?: (input: string) => any[]; /** * Function responsible for formatting values of quick filter in a string when the model is modified * @param {any[]} values The new values passed to the quick filter model * @returns {string} The string to display in the text field */ quickFilterFormatter?: (values: NonNullable<GridFilterModel['quickFilterValues']>) => string; /** * The debounce time in milliseconds. * @default 150 */ debounceMs?: number; }; declare function GridToolbarQuickFilter(props: GridToolbarQuickFilterProps): React.JSX.Element; declare namespace GridToolbarQuickFilter { var propTypes: any; } /** * Demos: * - [Filtering - overview](https://mui.com/x/react-data-grid/filtering/) * - [Filtering - quick filter](https://mui.com/x/react-data-grid/filtering/quick-filter/) * * API: * - [GridToolbarQuickFilter API](https://mui.com/x/api/data-grid/grid-toolbar-quick-filter/) */ export { GridToolbarQuickFilter };