Skip to main content

Interface: TouchListProps

Defined in: src/garminsdk/components/list/TouchList.tsx:8

Component props for TouchList.

Extends​

Properties​

bus?​

optional bus: EventBus

Defined in: src/garminsdk/components/list/TouchList.tsx:13

The event bus. Required for the list to respond appropriately to the mouse leaving the virtual cockpit instrument screen while the user is dragging the list.

children?​

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from​

ScrollListProps.children

class?​

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/garminsdk/components/list/ScrollList.tsx:49

CSS class(es) to apply to the list's root element.

Inherited from​

ScrollListProps.class

itemCount​

itemCount: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:46

The total number of items in the list.

Inherited from​

ScrollListProps.itemCount

itemsPerPage?​

optional itemsPerPage: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:37

The number of visible items per page. If not defined, the list will not snap to list items when scrolling.

Inherited from​

ScrollListProps.itemsPerPage

lengthPx?​

optional lengthPx: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:34

The length of the list, in pixels, along its scroll axis. If not defined, then the default value depends on whether the number of items per page is defined. If the number of items per page is defined, then the length defaults to the sum of the list item length and spacing multiplied by the number of items per page. If the number of items per page is not defined, then the length defaults to 100 pixels.

Inherited from​

ScrollListProps.lengthPx

listItemLengthPx​

listItemLengthPx: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:17

The length of each list item, in pixels, along the list's scroll axis.

Inherited from​

ScrollListProps.listItemLengthPx

listItemSpacingPx?​

optional listItemSpacingPx: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:20

The amount of space between each list item in pixels. Defaults to zero pixels.

Inherited from​

ScrollListProps.listItemSpacingPx

maxOverscrollPx?​

optional maxOverscrollPx: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:26

The maximum distance the list can overscroll past the beginning and end, in pixels. Defaults to the length of one list item.

Inherited from​

ScrollListProps.maxOverscrollPx

maxRenderedItemCount?​

optional maxRenderedItemCount: number | Subscribable<number>

Defined in: src/garminsdk/components/list/ScrollList.tsx:43

The maximum number of items that can be rendered simultaneously. Ignored if itemsPerPage is not defined. The value will be clamped to be greater than or equal to itemsPerPage * 3. Defaults to infinity.

Inherited from​

ScrollListProps.maxRenderedItemCount

ref?​

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from​

ScrollListProps.ref

scrollAxis?​

optional scrollAxis: "x" | "y"

Defined in: src/garminsdk/components/list/ScrollList.tsx:12

The axis along which the list scrolls. Defaults to y.

Inherited from​

ScrollListProps.scrollAxis