SearchSettings

Configures search functionality for the Data Grid component. Defines settings for enabling search, specifying search fields, and controlling search behavior. Manages how data is filtered based on user search input across grid columns.

Props

The following table outlines the props for the SearchSettings:

NameTypeDefaultDescription
caseSensitive
boolean
true

Controls case sensitivity for string searches in the grid. When true, searches are case-insensitive, treating uppercase and lowercase letters the same. When false, searches require exact case matching. Only affects string fields and not numbers, dates, or booleans.

enabled
boolean
false

Determines whether the search bar is enabled for the grid. When set to true, displays the search bar and allows to filter grid data. when false, disables search functionality. Affects the visibility and usability of the search UI in the grid.

fields
string[]
[ ]

Specifies an array of column field names to include in search operations. By default, includes all bounded columns in the grid. An empty array means no fields are searched. Allows targeting specific columns for search to optimize performance or relevance.

ignoreAccent
boolean
false

Enables accent-insensitive searching for string fields. When true, diacritic characters (e.g., accents like é, ñ) are ignored, treating them as their base characters. Enhances search usability for multilingual datasets.

operator
string
'contains'

Specifies the operator used for search operations, such as 'contains', 'startsWith', 'endsWith', 'equal', or 'notEqual'. Determines how the search value is matched against column data, affecting search precision. Must be compatible with the data types of the searched fields.

value
string
-

Defines the initial search value to filter grid records at rendering or the current search value. Used to pre-apply a search query on grid initialization or to retrieve the active search string. Supports dynamic updates to reflect user input in the search bar.