Skip to content

API Reference / @gtkx/components / index / ListItem

Type Alias: ListItem<T>

ListItem<T> = object

Defined in: types.d.ts:8

A single item in a collection model, identified by a stable id and holding an arbitrary value. Nested items form a tree.

Type Parameters

T

T = unknown

Properties

children?

optional children?: ListItem<T>[]

Defined in: types.d.ts:14

Child items nested under this one, which turn a plain item list into a tree.


hideExpander?

optional hideExpander?: boolean

Defined in: types.d.ts:16

Hides the tree expander arrow even when the item has children.


id

id: string

Defined in: types.d.ts:10

Stable identifier used to track the item across updates and selection.


indentForDepth?

optional indentForDepth?: boolean

Defined in: types.d.ts:18

Adds indentation matching the item's depth in the tree.


indentForIcon?

optional indentForIcon?: boolean

Defined in: types.d.ts:20

Reserves indentation space for an expander icon.


value

value: T

Defined in: types.d.ts:12

Payload handed to the cell renderer as ListItemRenderArgs.item.

Released under the MPL-2.0 License.