ColumnChooserSettings

Configures the behavior and appearance of the ColumnChooser dialog. Provides options for search, column ordering, and template customization.

Props

The following table outlines the props for the ColumnChooserSettings:

NameTypeDefaultDescription
enableReorder
boolean
false

Enables drag-and-drop reordering inside the column chooser. Requires grid-level column reordering to be enabled.

enableSearch
boolean
true

Enables or disables the search box in the ColumnChooser dialog.

footerTemplate
ComponentType<ColumnChooserFooterProps> | ReactElement | string
null

Custom template for the ColumnChooser dialog footer. Renders below the column list and receives ColumnChooserFooterProps.

headerTemplate
ComponentType | ReactElement | string
null

Custom template for the ColumnChooser dialog header. Replaces the default header area above the search box. Template receives no props by default.

ignoreAccent
boolean
false

Enables diacritics-insensitive searching in the ColumnChooser. When true, accent marks and special characters are ignored during search. Example: Searching for Resume matches Résumé.

immediateModeDelay
number
1500

Specifies the debounce delay for Immediate mode column visibility updates in milliseconds.

selectedColumns
string[]
[ ]

Ordered list of column field to display in the ColumnChooser. When provided, columns included in this array appear in the specified order. Columns not included retain their original position.

template
ComponentType<ColumnChooserTemplateProps> | ReactElement | string
null

Custom template that replaces the default column list and dialog content. Receives ColumnChooserTemplateProps including columns data and utility functions such as showColumns, hideColumns, and searchValue.