Skip to main content

Interface: GarminTouchListProps

Component props for TouchList.

Hierarchy

  • ScrollListProps

    GarminTouchListProps

Properties

bus

Optional bus: EventBus

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.

Defined in

garminsdk/components/list/TouchList.tsx:13


children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

ScrollListProps.children

Defined in

sdk/components/FSComponent.ts:122


class

Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

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

Inherited from

ScrollListProps.class

Defined in

garminsdk/components/list/ScrollList.tsx:49


itemCount

itemCount: number | Subscribable<number>

The total number of items in the list.

Inherited from

ScrollListProps.itemCount

Defined in

garminsdk/components/list/ScrollList.tsx:46


itemsPerPage

Optional itemsPerPage: number | Subscribable<number>

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

Inherited from

ScrollListProps.itemsPerPage

Defined in

garminsdk/components/list/ScrollList.tsx:37


lengthPx

Optional lengthPx: number | Subscribable<number>

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

Defined in

garminsdk/components/list/ScrollList.tsx:34


listItemLengthPx

listItemLengthPx: number | Subscribable<number>

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

Inherited from

ScrollListProps.listItemLengthPx

Defined in

garminsdk/components/list/ScrollList.tsx:17


listItemSpacingPx

Optional listItemSpacingPx: number | Subscribable<number>

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

Inherited from

ScrollListProps.listItemSpacingPx

Defined in

garminsdk/components/list/ScrollList.tsx:20


maxOverscrollPx

Optional maxOverscrollPx: number | Subscribable<number>

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

Defined in

garminsdk/components/list/ScrollList.tsx:26


maxRenderedItemCount

Optional maxRenderedItemCount: number | Subscribable<number>

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

Defined in

garminsdk/components/list/ScrollList.tsx:43


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

ScrollListProps.ref

Defined in

sdk/components/FSComponent.ts:125


scrollAxis

Optional scrollAxis: "x" | "y"

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

Inherited from

ScrollListProps.scrollAxis

Defined in

garminsdk/components/list/ScrollList.tsx:12