Interface ListProps<T>

Type Parameters

Hierarchy

  • ListProps

Properties

className? columnGap? columns data defaultSortOrder? enableSelectAll? enableSelectAllDeselect? errorMsg? generateItemLink? handleRetry? headerRowActionSize? headerRowHeight? horizontalTextAlign? inlineMenuActions? isError? isLoading? keyProperty? listRowActionSize? listRowHeight? loadingTriggerOffset? minimumWidth? onItemClicked? onItemSelected? onRequestMoreData? onRetry? onSortChanged? rowGap? selectionMode? showActionButton? textWrap? verticalTextAlign?

Properties

Optional className

className?: string

CSS Class name for additional styles

Optional columnGap

columnGap?: string

Spacing between columns

columns

columns: Column<T>[]

Column definitions The order of this array determines the order of columns

data

data: T[]

List data

Optional defaultSortOrder

defaultSortOrder?: SortData<T>

Defines how the list data should be sorted

Optional enableSelectAll

enableSelectAll?: boolean

In multiselect mode, whether the Select All button will be displayed. When Select All button is clicked the onItemClicked button will return SELECT_ALL instead of an array of items. (default: true)

Optional enableSelectAllDeselect

enableSelectAllDeselect?: boolean

Sets whether deselection should be allowed in multiselect mode when select all is enabled. This would allow the user to deselect items after select all checkbox is checked. Once an item is deselected, the list will switch to a SINGLE_ITEMS selection mode.

Optional errorMsg

errorMsg?: string

Optional error message to display if an error occurs. (default: 'There was an error.)

Optional generateItemLink

generateItemLink?: ((data) => LocationDescriptor<unknown>)

Type declaration

    • (data): LocationDescriptor<unknown>

    • When set, this function is used to generate the link that the user should be navigated to for each item.

      This property takes precedence over onItemClicked, which will not be executed in case generateItemLink is set!

      Parameters

      • data: T

      Returns LocationDescriptor<unknown>

Optional handleRetry

handleRetry?: boolean

Determines whether the component should render the error message and the 'onRetry' button. Set this to false if error handling will be done outside this component. (default: true)

Optional headerRowActionSize

headerRowActionSize?: string

Header checkbox size (default: '28px')

Optional headerRowHeight

headerRowHeight?: string

Header row height

Optional horizontalTextAlign

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

Horizontal alignment of text

Optional inlineMenuActions

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

Type declaration

    • (data): ActionData[]

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

      Parameters

      • data: T

      Returns ActionData[]

Optional isError

isError?: boolean

Defines whether there was an error with the data. If true a button will be shown that will trigger onRetry when hit.

Optional isLoading

isLoading?: boolean

Defines whether data is being loaded (default: false)

Optional keyProperty

keyProperty?: keyof T

The name of the property on the data object that should be used to identify objects (default: 'id')

Optional listRowActionSize

listRowActionSize?: string

List row action button and checkbox size (default: '50px')

Optional listRowHeight

listRowHeight?: string

List row height

Optional loadingTriggerOffset

loadingTriggerOffset?: number

Defines when the loading of the next page is triggered. The number represents the number of row left, before a load is triggered. (default: 10)

Optional minimumWidth

minimumWidth?: string

Minimum width of this component

Optional onItemClicked

onItemClicked?: ((data) => void | Promise<void>)

Type declaration

    • (data): void | Promise<void>

    • Raised when an data item is clicked.

      This is not being used, if generateItemLink is set!

      Parameters

      • data: T

      Returns void | Promise<void>

Optional onItemSelected

onItemSelected?: ((itemSelectEvent) => void)

Type declaration

    • (itemSelectEvent): void

    • Raised when item selection has changed

      Parameters

      Returns void

Optional onRequestMoreData

onRequestMoreData?: (() => void)

Type declaration

    • (): void

    • Raised when list has scrolled down to the item indicated by loadingTriggerOffset

      Returns void

Optional onRetry

onRetry?: (() => void)

Type declaration

    • (): void

    • Callback emitted if the user clicks on the retry button which is shown when isError is set to true

      Returns void

Optional onSortChanged

onSortChanged?: ((sort) => void)

Type declaration

    • (sort): void

    • Callback to emit when a sort event occurs. Name of the property and order of the direction are sent back.

      Parameters

      Returns void

Optional rowGap

rowGap?: string

Spacing between rows

Optional selectionMode

selectionMode?: ListSelectMode

Determines which select mode the list is in. (default: ListSelectMode.None) If 'Single' is selected, a check mark will be rendered for each row of data If 'Multi' is selected, a checkbox will be rendered for the header and each row of data

Optional showActionButton

showActionButton?: boolean | ((data) => boolean)

Defines whether an action button will be rendered (default: true) Will not render if selectMode is not 'None'

Type declaration

    • (data): boolean

    • Parameters

      • data: T

      Returns boolean

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" | "end" | "start"

Vertical alignment of text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc