List View Component

Props

The following table outlines the props for the List View component:

NameTypeDefaultDescription
checkBox
boolean
false

The checkBox property is used to render the checkbox in the ListView component.

checkBoxPosition
CheckBoxPosition
CheckBoxPosition.Left

The checkBoxPosition is used to set the position of check box in a list item. By default, the checkBoxPosition is Left, which will appear before the text content in a list item.

dataSource
{ [key: string]: Object }[] | DataManager
[ ]

The dataSource property provides the data to render the ListView component which is mapped with the fields of ListView.

disabled
boolean
false

The disabled property is used to enable or disable the ListView component.

fields
FieldsMapping
defaultMappedFields

The fields property is used to map keys from the dataSource which extracts the appropriate data from the dataSource with specified mapped with the column fields to render the ListView.

groupTemplate
Function | node
-

The ListView has an option to custom design the group header title with the help of groupTemplate property.

header
Function | node
-

The ListView has an option to custom design the ListView header title with the help of header property.

itemTemplate
Function | node
-

The ListView component supports to customize the content of each list items with the help of itemTemplate property.

query
Query
-

The query property is used to fetch the specific data from dataSource by using where and select keywords.

sortOrder
SortOrder
SortOrder.None

The sortOrder is used to sort the data source. The available type of sort orders are,

  • None - The data source is not sorting.
  • Ascending - The data source is sorting with ascending order.
  • Descending - The data source is sorting with descending order.
virtualization
VirtualizationProps
-

Provides configuration options for enabling and managing virtualization in the ListView component. Virtualization enhances performance by only rendering items that are currently visible in the viewport.

Events

The following table outlines the events for the List View component:

NameTypeDescription
onActionBegin
( ) => void

Triggers before the data binding process starts in ListView component.

onActionComplete
( ) => void

Triggers after the data binding process completes in ListView component.

onActionFailure
(event: object) => void

Triggers, when the data fetch request from the remote server, fails.

onScroll
(event: ScrolledEvent) => void

Triggers when the ListView component is scrolled.

onSelect
(event: ClickEvent) => void

Triggers when we click the ListView item in the component.