Interface: UiListButtonProps
Component props for UiListButton.
Hierarchy
ComponentPropsPick<UiTouchButtonProps,"isEnabled"|"isHighlighted"|"label"|"onTouched"|"onPressed"|"onHoldStarted"|"onHoldTick"|"onHoldEnded"|"onFocusGained"|"onFocusLost"|"gduFormat"|"canBeFocused">↳
UiListButtonProps
Properties
canBeFocused
• Optional canBeFocused: boolean | Subscribable<boolean>
Whether the button can be focused. Irrespective of this value, the button cannot be focused while it is disabled
or not visible. Defaults to true.
Inherited from
Pick.canBeFocused
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:108
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 apply to the button's root element.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListButton.tsx:36
fullSize
• Optional fullSize: boolean
Whether to render the button as a full-size button. A full-size button takes up the entire space allotted to the
the list item and is not surrounded by a visible border (besides the button's own border). Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListButton.tsx:24
gduFormat
• Optional gduFormat: GduFormat
The format of the button's parent GDU display. Used to set the button's inhibit on drag threshold unless otherwise
specified by the dragThresholdPx prop. Defaults to '460'.
Inherited from
Pick.gduFormat
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:96
isEnabled
• Optional isEnabled: boolean | Subscribable<boolean>
Whether the button is enabled, or a subscribable which provides it. Disabled buttons cannot be touched, primed,
pressed, or held. Defaults to true.
Inherited from
Pick.isEnabled
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:79
isHighlighted
• Optional isHighlighted: boolean | Subscribable<boolean>
Whether the button is highlighted, or a subscribable which provides it. Defaults to false.
Inherited from
Pick.isHighlighted
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:82
label
• Optional label: string | VNode | Subscribable<string>
The label for the button. Can be defined as either a static string, a subscribable which provides the label
string, or a VNode. If not defined, the button will not have a label.
If the label is defined as a VNode, all first-level DisplayComponents in the VNode tree will be destroyed when the button is destroyed.
Inherited from
Pick.label
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:94
onDestroy
• Optional onDestroy: () => void
A callback function to execute when the list item is destroyed.
Type declaration
▸ (): void
A callback function to execute when the list item is destroyed.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListButton.tsx:33
onFocusGained
• Optional onFocusGained: <B>(button: B, direction: UiFocusDirection) => void
A function which is called when the button gains UI focus.
Param
The button that gained UI focus.
Type declaration
▸ <B>(button, direction): void
A function which is called when the button gains UI focus.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that gained UI focus. |
direction | UiFocusDirection | - |
Returns
void
Inherited from
Pick.onFocusGained
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:66
onFocusLost
• Optional onFocusLost: <B>(button: B) => void
A function which is called when the button loses UI focus.
Param
The button that lost UI focus.
Type declaration
▸ <B>(button): void
A function which is called when the button loses UI focus.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that lost UI focus. |
Returns
void
Inherited from
Pick.onFocusLost
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:72
onHoldEnded
• Optional onHoldEnded: <B>(button: B, totalHoldDuration: number, endReason: TouchButtonHoldEndReason) => void
A function which is called when the button exits the held state.
Param
The button that was held.
Param
The total amount of time, in milliseconds, that the button was held.
Param
The reason that the button exited the held state.
Type declaration
▸ <B>(button, totalHoldDuration, endReason): void
A function which is called when the button exits the held state.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was held. |
totalHoldDuration | number | The total amount of time, in milliseconds, that the button was held. |
endReason | TouchButtonHoldEndReason | The reason that the button exited the held state. |
Returns
void
Inherited from
Pick.onHoldEnded
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:60
onHoldStarted
• Optional onHoldStarted: <B>(button: B) => TouchButtonHoldAction
A function which is called when the button enters the held state. If not defined, then the button will default to taking no specific action when it enters the held state.
Param
The button that is held.
Type declaration
▸ <B>(button): TouchButtonHoldAction
A function which is called when the button enters the held state. If not defined, then the button will default to taking no specific action when it enters the held state.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
Returns
TouchButtonHoldAction
The action to take. Ignored if the value is equal to TouchButtonHoldAction.EndHold.
Inherited from
Pick.onHoldStarted
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:40
onHoldTick
• Optional onHoldTick: <B>(button: B, dt: number, totalTime: number, timeSinceLastPress: number) => TouchButtonHoldAction
A function which is called every frame when the button is held. If not defined, then the button will default to taking no specific action with each frame tick.
Param
The button that is held.
Param
The elapsed time, in milliseconds, since the previous frame.
Param
The total amount of time, in milliseconds, that the button has been held.
Param
The amount of time, in milliseconds, that the button has been held since the last time the button was pressed as a tick action.
Type declaration
▸ <B>(button, dt, totalTime, timeSinceLastPress): TouchButtonHoldAction
A function which is called every frame when the button is held. If not defined, then the button will default to taking no specific action with each frame tick.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
dt | number | The elapsed time, in milliseconds, since the previous frame. |
totalTime | number | The total amount of time, in milliseconds, that the button has been held. |
timeSinceLastPress | number | The amount of time, in milliseconds, that the button has been held since the last time the button was pressed as a tick action. |
Returns
TouchButtonHoldAction
The action to take.
Inherited from
Pick.onHoldTick
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:52
onPressed
• Optional onPressed: <B>(button: B, isHeld: boolean) => void
A callback function which will be called every time the button is pressed.
Param
The button that was pressed.
Param
Whether the button was held when it was pressed.
Type declaration
▸ <B>(button, isHeld): void
A callback function which will be called every time the button is pressed.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was pressed. |
isHeld | boolean | Whether the button was held when it was pressed. |
Returns
void
Inherited from
Pick.onPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:32
onTouched
• Optional onTouched: <B>(button: B) => TouchButtonOnTouchedAction
A callback function which will be called every time the button is touched (i.e. a mouse down event on the button is detected). If not defined, then the button will default to attempting to set focus on its focus module and entering the primed state when touched.
Param
The button that was touched.
Type declaration
▸ <B>(button): TouchButtonOnTouchedAction
A callback function which will be called every time the button is touched (i.e. a mouse down event on the button is detected). If not defined, then the button will default to attempting to set focus on its focus module and entering the primed state when touched.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was touched. |
Returns
TouchButtonOnTouchedAction
The action to take as a result of the button being touched.
Inherited from
Pick.onTouched
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:25
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
useListItemStyle
• Optional useListItemStyle: boolean
Whether to style the button to appear as a list item instead of a touchscreen button. Ignored if fullSize is
false. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListButton.tsx:30