List Collection

Display items in a list layout.

A list of options presented in a list layout to select an individual value. Options are dynamically mapped from a query, transformer, or any other data source.

Properties

bodyByIndex

string[]

A list of body values for each option, by index.

cardSize

'full' | 'half'

The size with which to render cards on the layout.

cardStyle

'flat' | 'elevated'

The style with which to render cards on the layout.

cardType

'compact' | 'card'

The type of card to render on the layout.

data

object[]

Source data for the component.

hidden

boolean

Whether the component is visible.

id

string

The name of the component.

itemMode

'dynamic'

The evaluation mode for items.

pluginType

string

The component type.

prefixIconByIndex

IconKey[]

A list of prefix icons for each item, by index..

prefixImageFitByIndex

'cover' | 'contain' | 'stretch' | 'center'

A list of image fit values for each item, by index.

prefixImageSizeByIndex

string[]

A list of image aspect ratios for each item, by index.

prefixTypeByIndex

string[]

A list of prefix types for each item, by index.

scrollDirection

'horizontal' | 'vertical'

The scroll direction.

selectedIndex

number | null

The index of the currently selected item.

selectedItem

any

The currently selected item.

showSeparator

boolean

Whether to render a separator between items.

subtitleByIndex

string[]

A list of subtitle values for each item, by index.

subtitleLengthByIndex

number[]

A list of subtitle value lengths for each item, by index.

suffixIconByIndex

IconKey[]

A list of suffix icons for each item, by index.

suffixTextByIndex

string[]

A list of suffix text values for each item, by index.

suffixTypeByIndex

string[]

A list of suffix types for each item, by index.

suffixValueByIndex

string[]

A list of suffix values for each item, by index.

titleByIndex

string[]

A list of title values for each item, by index.