Interface: UiListSelectTouchButtonProps<S>
Component props for UiListSelectTouchButton.
Type parameters
| Name | Type |
|---|---|
S | extends MutableSubscribable<any, any> |
Hierarchy
Omit<UiValueTouchButtonProps<S>,"state"|"onPressed"|"gduFormat">↳
UiListSelectTouchButtonProps
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
Omit.canBeFocused
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:123
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Omit.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.
Inherited from
Omit.class
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:129
containerRef
• Optional containerRef: NodeReference<HTMLElement>
A reference to the UI view container that contains the button. Required in order to open the button's UI list dialog as a positioned popup.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:41
dialogBackgroundOcclusion
• Optional dialogBackgroundOcclusion: UiViewOcclusionType
The occlusion type to apply to views beneath the UI list dialog popup. Defaults to 'darken'.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:68
dialogPositionAlign
• Optional dialogPositionAlign: "top-right" | "bottom-left" | "bottom-right" | "top-left"
The edges of the button to which to align the reference corner of the button's UI list dialog. Ignored if
openDialogAsPositioned is false. Defaults to top-left.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:53
dialogPositionReference
• Optional dialogPositionReference: "top-right" | "bottom-left" | "bottom-right" | "top-left"
The reference corner of the button's UI list dialog, which will be aligned to the button if
openDialogAsPositioned is true. Defaults to top-left.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:47
dialogPositionXOffset
• Optional dialogPositionXOffset: number
The horizontal offset to apply to the button's UI list dialog positioning after alignment with the button, in
pixels. Ignored if openDialogAsPositioned is false. Defaults to 0.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:59
dialogPositionYOffset
• Optional dialogPositionYOffset: number
The vertical offset to apply to the button's UI list dialog positioning after alignment with the button, in
pixels. Ignored if openDialogAsPositioned is false. Defaults to 0.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:65
dragThresholdPx
• Optional dragThresholdPx: number
The distance, in pixels, the mouse can click and drag before the pad begins to ignore mouse events. Ignored if
inhibitOnDrag is false. Defaults to 40 pixels.
Inherited from
Omit.dragThresholdPx
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:156
focusController
• Optional focusController: UiFocusController
A UI focus controller with which to automatically register the button after it is rendered. If not defined, then the button will not be automatically registered with any controller, but it may still be registered manually.
Inherited from
Omit.focusController
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:117
focusOnDrag
• Optional focusOnDrag: boolean
Whether the pad should focus all mouse events when dragging, preventing them from bubbling up to any ancestors
in the DOM tree. Defaults to true.
Inherited from
Omit.focusOnDrag
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:93
focusOptions
• Optional focusOptions: Readonly<UiTouchButtonFocusModuleOptions>
Options to configure the button's behavior related to UI focus.
Inherited from
Omit.focusOptions
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:126
hideDropdownArrow
• Optional hideDropdownArrow: boolean
Whether to hide the button's dropdown arrow. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:71
highlightButtonWhileListIsOpen
• Optional highlightButtonWhileListIsOpen: boolean
When true, the button will be highlighted while the list is open, and the isHighlighted prop will be ignored. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:80
inhibitOnDrag
• Optional inhibitOnDrag: boolean
Whether the button should stop responding to mouse events and instead forward them to its parent after clicking
and dragging for a certain distance defined by dragThresholdPx along the axis defined by inhibitOnDragAxis.
When mouse events are inhibited, the button cannot be primed or held. Defaults to false.
Inherited from
Omit.inhibitOnDrag
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:150
inhibitOnDragAxis
• Optional inhibitOnDragAxis: "both" | "x" | "y"
The axis along which dragging will trigger the inhibit function. Ignored if inhibitOnDrag is false.
Defaults to 'both'.
Inherited from
Omit.inhibitOnDragAxis
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:162
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
Omit.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
Omit.isHighlighted
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:82
isInList
• Optional isInList: boolean
Whether the button is in a scrollable list. If true, will enable the inhibit on drag function unless otherwise
specified by the inhibitOnDrag prop. Defaults to false.
Inherited from
Omit.isInList
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:99
isVisible
• Optional isVisible: boolean | Subscribable<boolean>
Whether the button is visible. Defaults to true.
Inherited from
Omit.isVisible
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:85
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
Omit.label
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:94
listDialogKey
• listDialogKey: string
The key of the UI list dialog the button will open as a selection list.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:29
listDialogLayer
• listDialogLayer: UiViewStackLayer
The view stack layer in which to open the button's UI list dialog.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:26
listParams
• listParams: (state: S) => UiListDialogParams<MutableSubscribableInputType<S>> | UiListDialogParams<MutableSubscribableInputType<S>>
Parameters to pass to the selection list dialog, or a function which will return the parameters when called each time the list is opened.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:86
listScrollAxis
• Optional listScrollAxis: "x" | "y"
The scroll axis of the button's parent list. Ignored if isInList is false. Sets the button's inhibit on drag
axis unless otherwise specified by the inhibitOnDragAxis prop. Defaults to y.
Inherited from
Omit.listScrollAxis
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:105
onCancelled
• Optional onCancelled: <B>(state: S, button: B) => void
A callback function which will be called each time a list dialog opened by the button is closed before a value is selected.
Type declaration
▸ <B>(state, button): void
A callback function which will be called each time a list dialog opened by the button is closed before a value is selected.
Type parameters
| Name | Type |
|---|---|
B | extends UiListSelectTouchButton<S> = UiListSelectTouchButton<S> |
Parameters
| Name | Type |
|---|---|
state | S |
button | B |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:98
onDestroy
• Optional onDestroy: () => void
A callback function which will be called when the button is destroyed.
Type declaration
▸ (): void
A callback function which will be called when the button is destroyed.
Returns
void
Inherited from
Omit.onDestroy
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:165
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 UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that gained UI focus. |
direction | UiFocusDirection | - |
Returns
void
Inherited from
Omit.onFocusGained
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:81
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 UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that lost UI focus. |
Returns
void
Inherited from
Omit.onFocusLost
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:87
onHoldEnded
• Optional onHoldEnded: <B>(button: B, state: S, 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 state that is bound to the button.
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, state, totalHoldDuration, endReason): void
A function which is called when the button exits the held state.
Type parameters
| Name | Type |
|---|---|
B | extends UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was held. |
state | S | The state that is bound to the button. |
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
Omit.onHoldEnded
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:70
onHoldStarted
• Optional onHoldStarted: <B>(button: B, state: S) => 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.
Param
The state that is bound to the button.
Type declaration
▸ <B>(button, state): 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 UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
state | S | The state that is bound to the button. |
Returns
TouchButtonHoldAction
The action to take. Ignored if the value is equal to TouchButtonHoldAction.EndHold.
Inherited from
Omit.onHoldStarted
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:42
onHoldTick
• Optional onHoldTick: <B>(button: B, state: S, 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 state that is bound to the button.
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, state, 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 UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
state | S | The state that is bound to the button. |
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
Omit.onHoldTick
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:55
onSelected
• Optional onSelected: <B>(value: MutableSubscribableInputType<S>, state: S, button: B) => void
A callback function which will be called each time a value is selected from a list dialog opened by the button. If not defined, then selecting a value from the list will automatically set the button's bound state.
Type declaration
▸ <B>(value, state, button): void
A callback function which will be called each time a value is selected from a list dialog opened by the button. If not defined, then selecting a value from the list will automatically set the button's bound state.
Type parameters
| Name | Type |
|---|---|
B | extends UiListSelectTouchButton<S> = UiListSelectTouchButton<S> |
Parameters
| Name | Type |
|---|---|
value | MutableSubscribableInputType<S> |
state | S |
button | B |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:92
onTouched
• Optional onTouched: <B>(button: B, state: S) => 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 entering the primed state when touched.
Param
The button that was touched.
Param
The state that is bound to the button.
Type declaration
▸ <B>(button, state): 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 entering the primed state when touched.
Type parameters
| Name | Type |
|---|---|
B | extends UiValueTouchButton<S> = UiValueTouchButton<S> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was touched. |
state | S | The state that is bound to the button. |
Returns
TouchButtonOnTouchedAction
The action to take as a result of the button being touched.
Inherited from
Omit.onTouched
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiValueTouchButton.tsx:25
openDialogAsPositioned
• Optional openDialogAsPositioned: boolean
Whether to open the button's UI list dialog as a positioned popup. If false, then the dialog will be opened as a
normal popup. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:35
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Omit.ref
Defined in
src/sdk/components/FSComponent.ts:125
renderValue
• Optional renderValue: VNode | (stateValue: SubscribableType<S>) => string | VNode
A function which renders the value of the button's bound state, or a VNode which renders the value. If not
defined, values are rendered into strings via default toString() behavior.
If the rendered value is a VNode, all first-level DisplayComponents in the VNode tree will be destroyed when a new value is rendered or when the button is destroyed.
Inherited from
Omit.renderValue
Defined in
src/garminsdk/components/touchbutton/ValueTouchButton.tsx:21
state
• state: S
A mutable subscribable whose state will be bound to the button.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:74
uiService
• uiService: UiService
The UI service.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:23