Optional classOptional columnSpacing between columns
Column definitions The order of this array determines the order of columns
Optional customCustom row renderer - if it returns null, the default ListRow will be used
List data
Optional defaultDefines how the list data should be sorted
Optional enableIn 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 enableSets 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 errorOptional error message to display if an error occurs. (default: 'There was an error.)
Optional generateWhen 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!
Optional handleDetermines 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 headerHeader checkbox size (default: '28px')
Optional headerHeader row height
Optional horizontalHorizontal alignment of text
Optional inlineProvide inline actions which are available through '...' context menu
Optional isDefines whether there was an error with the data. If true a button will be shown that will trigger onRetry when hit.
Optional isDefines whether data is being loaded (default: false)
Optional isFunction to determine if a specific row should be disabled
Optional keyThe name of the property on the data object that should be used to identify objects (default: 'id')
Optional listList row action button and checkbox size (default: '50px')
Optional listList row height
Optional loadingDefines 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 minimumMinimum width of this component
Optional onRaised when an data item is clicked.
This is not being used, if generateItemLink is set!
Optional onRaised when item selection has changed
Optional onRaised when list has scrolled down to the item indicated by loadingTriggerOffset
Optional onCallback emitted if the user clicks on the retry button which is shown when isError is set to true
Optional onCallback to emit when a sort event occurs. Name of the property and order of the direction are sent back.
Optional rowSpacing between rows
Optional selectionDetermines 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 showDefines whether an action button will be rendered (default: true) Will not render if selectMode is not 'None'
Optional textIf set to true, column text overflow will be wrapped to a new line. Otherwise, it will be truncated with an ellipsis (default: false)
Optional verticalVertical alignment of text
Generated using TypeDoc
CSS Class name for additional styles