ColumnChooserTemplateProps

Props passed to the Column Chooser template.

Props

The following table outlines the props for the ColumnChooserTemplateProps:

NameTypeDefaultDescription
columnVisibility
Map<string, boolean>
-

Current visibility map keyed by field or uid.

columns
Partial<ColumnProps<T>>[]
-

Array of all columns available in the Column Chooser. Each item is a partial ColumnProps<T> object.

hideColumns
string[]
-

Array of currently hidden column fields.

onApply
( ) => void
-

Apply/OK handler exposed to templates.

onClose
( ) => void
-

Close/Cancel handler exposed to templates.

onSelectAll
(checked: boolean) => void
-

Toggle handler for the "Select All" action. Receives the target checked state.

onToggle
(fieldOrUid: string, checked: boolean) => void
-

Toggle handler for individual columns. Receives the column field or uid and the target checked state.

searchValue
string
-

Current search value in the chooser search box.

showColumns
string[]
-

Array of currently visible column fields.