ColumnFilterParams

Configures filtering behavior for columns in the Syncfusion React Data Grid. Defines settings for the filter UI, operator, and component parameters. Used to customize how data is filtered within specific columns.

Props

The following table outlines the props for the ColumnFilterParams:

NameTypeDefaultDescription
filterBarType
string | FilterBarType
'StringFilter' | FilterBarType.TextBox

Specifies the filter type for the column, such as stringFilter or numericFilter. Defines the filtering logic applied to the column’s data, aligning with its data type. Ensures appropriate filtering behavior for strings, numbers, or other data.

filterOperators
string[]
[ ]

Specifies the operators available for filtering operations in the column. Defines which filter operators (e.g., 'equals', 'contains', 'greaterThan') are enabled for the column's filter UI. Allows customization of available filtering options based on column-specific requirements.

hideSearchbox
boolean
false

Specifies whether the search box in the Excel/CheckBox filter dialog is hidden. When set to true, hides the search input field that allows users to filter checkbox items. When set to false or undefined, displays the search box for filtering through available checkbox options.

operator
string
''

Defines the operator used for filtering requests, such as contains or equal. Specifies how the filter value is matched against column data during filtering. Used to customize the filtering logic for specific columns.

params
Partial<TextBoxProps & NumericTextBoxProps & DatePickerProps & DropDownListProps>
{}

Specifies configuration parameters for the filter component, such as text box, numeric input, or dropdown properties. Allows customization of the filter UI components, like placeholders or value ranges. Enhances the filtering experience with tailored input controls.