@serenity-is/corelib / ColumnPickerDialogOptions

Interface: ColumnPickerDialogOptions

Defined in: src/ui/datagrid/columnpickerdialog.tsx:31

Options for the ColumnPickerDialog.

Properties

columns?

optional columns: Column<any>[] | () => Column<any>[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:33

Columns to display in the picker, or a function returning them.

---

dataGrid?

optional dataGrid: IDataGrid

Defined in: src/ui/datagrid/columnpickerdialog.tsx:39

Data grid the picker is associated with.

---

defaultOrder?

optional defaultOrder: string[] | () => string[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:35

Default column order, or a function returning it.

---

defaultVisible?

optional defaultVisible: string[] | () => string[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:37

Default visible column ids, or a function returning them.

---

onChange()?

optional onChange: (args) => Promise<any>

Defined in: src/ui/datagrid/columnpickerdialog.tsx:43

Callback invoked when the picker state changes.

Parameters

args

ColumnPickerChangeArgs

Returns

Promise<any>

---

reorderColumns()?

optional reorderColumns: (columnIds, setVisible?) => boolean

Defined in: src/ui/datagrid/columnpickerdialog.tsx:47

Custom handler for reordering columns.

Parameters

columnIds

string[]

setVisible?

string[]

Returns

boolean

---

sleekGrid?

optional sleekGrid: ISleekGrid

Defined in: src/ui/datagrid/columnpickerdialog.tsx:41

SleekGrid instance the picker operates on.

---

toggleColumns()?

optional toggleColumns: (columnIds, show?) => Column<any>[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:45

Custom handler for toggling column visibility.

Parameters

columnIds

string[]

show?

boolean

Returns

Column<any>[]