Interface ListRowProps<T>

Type Parameters

Hierarchy

  • ListRowProps

Properties

actionSize columnGap columnSizes columns data horizontalTextAlign? inlineMenuActions? isRowDisabled? itemSelected? onItemClicked? onItemSelected? rowHeight? selectionMode? showActionButton? showCheckMark? showItemCheckbox? textWrap? verticalTextAlign?

Properties

actionSize

actionSize: string

Size of action button and checkbox

columnGap

columnGap: string

Header row height

columnSizes

columnSizes: string

Spacing between columns

columns

columns: Column<T>[]

The column definition

data

data: T

List data

Optional horizontalTextAlign

horizontalTextAlign?: "right" | "left" | "center"

Horizontal alignment of text (default: left)

Optional inlineMenuActions

inlineMenuActions?: ((data) => ActionData[])

Type declaration

    • (data): ActionData[]

    • Provide inline actions which are available through '...' context menu

      Parameters

      • data: T

      Returns ActionData[]

Optional isRowDisabled

isRowDisabled?: boolean

Defines whether a row is disabled (default: false)

Optional itemSelected

itemSelected?: boolean

Whether or not the item is selected (default: false)

Optional onItemClicked

onItemClicked?: LocationDescriptor<unknown> | ((data) => void)

Used for when a row is clicked. This can be either a callback function that will be executed or a URL where the user should be navigated to. When the list should navigate the user to e.g. a details page of a entry it is recommended to directly pass the URL here instead of a callback function that does the routing in JavaScript.

Type declaration

    • (data): void

    • Parameters

      • data: T

      Returns void

Optional onItemSelected

onItemSelected?: ((checked) => void)

Type declaration

    • (checked): void

    • A function that is getting called, when the selection state of the row changes.

      Parameters

      • checked: boolean

      Returns void

Optional rowHeight

rowHeight?: string

List row height

Optional selectionMode

selectionMode?: ListSelectMode

Determines which selection mode the list is in. (default: ListSelectMode.None)

Optional showActionButton

showActionButton?: boolean

Defines whether an action button will be rendered (default: true)

Optional showCheckMark

showCheckMark?: boolean

Defines whether a check mark action button will be rendered (default: true)

Optional showItemCheckbox

showItemCheckbox?: boolean

Defines whether a checkbox for each item should be rendered (default: false)

Optional textWrap

textWrap?: boolean

If set to true, column text overflow will be wrapped to a new line. Otherwise, it will be truncated with an ellipsis (default: false)

Optional verticalTextAlign

verticalTextAlign?: "center" | "start" | "end"

Vertical alignment of text (default: right)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc