SearchState Plugin Reference

A plugin that manages the search state.

Import

Use the following statement to import the plugin:

import { SearchState } from '@devexpress/dx-react-grid';

User Reference

Dependencies

none

Properties

Name Type Default Description
value? string   Specifies the applied search value.
defaultValue? string   Specifies the search value initially applied in the uncontrolled mode.
onValueChange? (value: string) => void   Handles search value changes.

Plugin Developer Reference

Imports

Name Plugin Type Description
filterExpression Getter FilterExpression | Filter The applied filter expressions.
columns Getter Array<Column> Grid columns.

Exports

Name Plugin Type Description
searchValue Getter string The applied search value.
filterExpression Getter FilterExpression | Filter The applied filter expressions.
changeSearchValue Action ({ value: string }) => void Fires the onValueChange event with the corresponding value and changes the search value.