FilterSettings

Defines the configuration for filtering functionality in the Data Grid component. Specifies settings for enabling filtering, defining filter conditions, and customizing the filter UI. Controls how data is filtered based on user input and predefined criteria.

Props

The following table outlines the props for the FilterSettings:

NameTypeDefaultDescription
caseSensitive
boolean
false

Enables or disables case-sensitive filtering for string fields. When true, string filtering distinguishes between uppercase and lowercase letters. When false, it is case-insensitive. Does not affect filtering for numbers, booleans, or dates.

columns
[ ]

Specifies an array of FilterPredicates objects to define initial or active filter conditions for grid columns. Each predicate represents a filter rule applied to a specific column, such as field, operator, and value. Used to pre-filter data on grid initialization or to retrieve the current filter state.

enableFilterBarOperator
boolean
false

Determines whether filter bar operators are enabled for the grid. When set to true, allows users to select custom operators (e.g., equals, contains, greater than) in the filter bar for more advanced filtering capabilities. When false, only basic filtering is available. This setting works in conjunction with the enabled property to control filter behavior.

enabled
boolean
false

Determines whether filtering is enabled for the grid’s columns. When set to true, allows to apply filters via the filter bar. When false, disables all filtering functionality from the grid. Affects all columns unless overridden by individual column settings.

ignoreAccent
boolean
false

Enables or disables accent-insensitive filtering for string fields. When true, diacritic characters (e.g., accents like é, ñ) are ignored during filtering, treating them as their base characters. Improves filter usability for multilingual datasets.

immediateModeDelay
number
1500

Sets the time delay (in milliseconds) for filtering in Immediate mode. Controls the wait time before the grid processes filter input, balancing responsiveness and performance. Only applicable when the filter mode is set to Immediate.

mode
FilterBarMode | string
'Immediate'

Specifies the operational mode of the filter bar, controlling when filtering is triggered. Supports OnEnter (filtering starts when the Enter key is pressed) or Immediate (filtering starts after a time delay). Influences the responsiveness and user experience of filtering interactions.