Interface: UiListProps<DataType>
Component props for UiList.
Type parameters
| Name |
|---|
DataType |
Hierarchy
ComponentProps↳
UiListProps
Properties
animateScrollToFocus
• Optional animateScrollToFocus: boolean | Subscribable<boolean>
Whether to animate scrolling when the list automatically scrolls to a newly focused item. Defaults to true.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:80
autoDisableOverscroll
• Optional autoDisableOverscroll: boolean | Subscribable<boolean>
Whether to automatically disable overscrolling when the total height of all the list's items does not exceed the
list's visible height. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:61
autoRefocus
• Optional autoRefocus: boolean
Whether the list should automatically try to focus another item if the focused item loses focus because it could
no longer be focused or if it was removed from the list. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:86
bus
• bus: EventBus
The event bus.
Overrides
UiListFormattingProps.bus
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:30
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
ComponentProps.children
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>
CSS class(es) to add to the list's root element.
Overrides
UiListFormattingProps.class
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:109
data
• Optional data: SubscribableArray<DataType>
The data to display in the list. If both this property and renderItem are defined, the list will display
rendered data items instead of its children.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:42
fadeScrollBar
• Optional fadeScrollBar: boolean | Subscribable<boolean>
Whether to fade out the scroll bar when the total height of all the list's items is less than or equal to the
list's visible height. Space is reserved for the scroll bar even when it is faded out. Defaults to true.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:75
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
UiListFormattingProps.itemsPerPage
Defined in
src/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
UiListFormattingProps.lengthPx
Defined in
src/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
UiListFormattingProps.listItemLengthPx
Defined in
src/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
UiListFormattingProps.listItemSpacingPx
Defined in
src/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
UiListFormattingProps.maxOverscrollPx
Defined in
src/garminsdk/components/list/ScrollList.tsx:26
maxRenderedItemCount
• Optional maxRenderedItemCount: number | Subscribable<number>
The maximum number of items that can be rendered simultaneously. Ignored if data, renderItem, or
itemsPerPage is not defined. The value will be clamped to be greater than or equal to itemsPerPage * 3.
Defaults to infinity.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:55
onDestroy
• Optional onDestroy: () => void
A callback function to execute when the list is destroyed.
Type declaration
▸ (): void
A callback function to execute when the list is destroyed.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:106
onTopVisibleIndexChanged
• Optional onTopVisibleIndexChanged: (topVisibleIndex: number) => void
A callback that will be called with the topVisibleIndex when it changes.
Type declaration
▸ (topVisibleIndex): void
A callback that will be called with the topVisibleIndex when it changes.
Parameters
| Name | Type |
|---|---|
topVisibleIndex | number |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:103
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
renderItem
• Optional renderItem: (data: DataType, index: number) => VNode
A function that renders a single data item into the list. If both this property and data are defined, the
list will display rendered data items instead of its children.
Type declaration
▸ (data, index): VNode
A function that renders a single data item into the list. If both this property and data are defined, the
list will display rendered data items instead of its children.
Parameters
| Name | Type |
|---|---|
data | DataType |
index | number |
Returns
VNode
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:48
showScrollBar
• Optional showScrollBar: boolean | "auto" | Subscribable<boolean | "auto">
Whether to show the list's scroll bar. If true, then space is always reserved for the scroll bar, and its
visibility depends on the fadeScrollBar option. If false, then no space is reserved for the scroll bar and it
is always hidden. If auto, then space is reserved for the scroll bar if and only if the total height of all the
list's items exceeds the list's visible height. Defaults to true.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:69
sortItems
• Optional sortItems: (a: DataType, b: DataType) => number
A function to sort data items before rendering them. The function should return a negative number if the first item should be rendered before the second, a positive number if the first item should be rendered after the second, or zero if the two items' relative order does not matter. If not defined, items will be rendered in the order in which they appear in the data array.
Type declaration
▸ (a, b): number
A function to sort data items before rendering them. The function should return a negative number if the first item should be rendered before the second, a positive number if the first item should be rendered after the second, or zero if the two items' relative order does not matter. If not defined, items will be rendered in the order in which they appear in the data array.
Parameters
| Name | Type |
|---|---|
a | DataType |
b | DataType |
Returns
number
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:100
staticChildren
• Optional staticChildren: VNode
A VNode which will be rendered into the list's translating container and positioned after the container that holds the list's rendered items.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:92
validKnobIds
• Optional validKnobIds: Iterable<UiKnobId>
The IDs of the valid bezel rotary knobs that can be used to change the list's focused item. If not defined, then knobs cannot be used to change the list's focused item.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:36