@serenity-is/corelib / TreeGridMixinOptions

Interface: TreeGridMixinOptions<TItem>

Defined in: src/ui/datagrid/treegridmixin.ts:125

Options for TreeGridMixin.

Type Parameters

TItem

TItem

Row type displayed in the grid.

Properties

getParentId()

getParentId: (item) => any

Defined in: src/ui/datagrid/treegridmixin.ts:129

Callback that returns the parent identifier for a row.

Parameters

item

TItem

Returns

any

---

grid

grid: DataGrid<TItem, any>

Defined in: src/ui/datagrid/treegridmixin.ts:127

Target data grid to enhance with tree behaviour.

---

initialCollapse()?

optional initialCollapse: () => boolean

Defined in: src/ui/datagrid/treegridmixin.ts:133

Optional callback that controls whether rows start collapsed.

Returns

boolean

---

toggleField

toggleField: string

Defined in: src/ui/datagrid/treegridmixin.ts:131

Field / column id where the expand/collapse toggle is rendered.