Skip to main content

Interface: UiTouchButtonProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:15

Component props for UiTouchButton.

Extends​

  • Omit<TouchButtonProps, "onTouched" | "onPressed" | "onHoldStarted" | "onHoldTick" | "onHoldEnded" | "focusOnDrag" | "class">

Properties​

canBeFocused?​

optional canBeFocused: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:108

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.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

Omit.children

class?​

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:114

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

dragThresholdPx?​

optional dragThresholdPx: number

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:156

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

focusController?​

optional focusController: UiFocusController

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:102

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.

focusOnDrag?​

optional focusOnDrag: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:78

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.

focusOptions?​

optional focusOptions: Readonly<UiTouchButtonFocusModuleOptions>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:111

Options to configure the button's behavior related to UI focus.

gduFormat?​

optional gduFormat: GduFormat

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:96

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'.

inhibitOnDrag?​

optional inhibitOnDrag: boolean

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:150

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

inhibitOnDragAxis?​

optional inhibitOnDragAxis: "both" | "x" | "y"

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:162

The axis along which dragging will trigger the inhibit function. Ignored if inhibitOnDrag is false. Defaults to 'both'.

Inherited from​

Omit.inhibitOnDragAxis

isEnabled?​

optional isEnabled: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:79

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

isHighlighted?​

optional isHighlighted: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:82

Whether the button is highlighted, or a subscribable which provides it. Defaults to false.

Inherited from​

Omit.isHighlighted

isInList?​

optional isInList: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:84

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.

isVisible?​

optional isVisible: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:85

Whether the button is visible. Defaults to true.

Inherited from​

Omit.isVisible

label?​

optional label: string | VNode | Subscribable<string>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:94

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

listScrollAxis?​

optional listScrollAxis: "x" | "y"

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:90

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.

onDestroy()?​

optional onDestroy: () => void

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:165

A callback function which will be called when the button is destroyed.

Returns​

void

Inherited from​

Omit.onDestroy

onFocusGained()?​

optional onFocusGained: <B>(button, direction) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:66

A function which is called when the button gains UI focus.

Type Parameters​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that gained UI focus.
directionUiFocusDirection-

Returns​

void

onFocusLost()?​

optional onFocusLost: <B>(button) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:72

A function which is called when the button loses UI focus.

Type Parameters​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that lost UI focus.

Returns​

void

onHoldEnded()?​

optional onHoldEnded: <B>(button, totalHoldDuration, endReason) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:60

A function which is called when the button exits the held state.

Type Parameters​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that was held.
totalHoldDurationnumberThe total amount of time, in milliseconds, that the button was held.
endReasonTouchButtonHoldEndReasonThe reason that the button exited the held state.

Returns​

void

onHoldStarted()?​

optional onHoldStarted: <B>(button) => TouchButtonHoldAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:40

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​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that is held.

Returns​

TouchButtonHoldAction

The action to take. Ignored if the value is equal to TouchButtonHoldAction.EndHold.

onHoldTick()?​

optional onHoldTick: <B>(button, dt, totalTime, timeSinceLastPress) => TouchButtonHoldAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:52

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​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that is held.
dtnumberThe elapsed time, in milliseconds, since the previous frame.
totalTimenumberThe total amount of time, in milliseconds, that the button has been held.
timeSinceLastPressnumberThe 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.

onPressed()?​

optional onPressed: <B>(button, isHeld) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:32

A callback function which will be called every time the button is pressed.

Type Parameters​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that was pressed.
isHeldbooleanWhether the button was held when it was pressed.

Returns​

void

onTouched()?​

optional onTouched: <B>(button) => TouchButtonOnTouchedAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:25

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​

Type ParameterDefault type
B extends UiTouchButtonUiTouchButton

Parameters​

ParameterTypeDescription
buttonBThe button that was touched.

Returns​

TouchButtonOnTouchedAction

The action to take as a result of the button being touched.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

Omit.ref