Skip to main content

Interface: GtcListButtonProps

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:9

The props for GtcListButton.

Extends

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

Omit.children


fullSizeButton?

optional fullSizeButton: boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:17

Whether the button should fill the entire list item. Overrides hideBorder to be true when true. Defaults to false.


gtcOrientation?

optional gtcOrientation: GtcOrientation

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcTouchButton.tsx:34

The orientation of the button's parent GTC. Used to set the button's inhibit on drag threshold unless otherwise specified by the dragThresholdPx prop. Defaults to 'horizontal'.

Inherited from

Pick.gtcOrientation


hideBorder?

optional hideBorder: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListItem.tsx:14

Hides the list item border, allowing the content to easily fill the entire space of the list-item. Defaults to false.

Inherited from

Omit.hideBorder


isEnabled?

optional isEnabled: boolean | Subscribable<boolean>

Defined in: 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

Pick.isEnabled


isHighlighted?

optional isHighlighted: boolean | Subscribable<boolean>

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

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

Inherited from

Pick.isHighlighted


label?

optional label: string | VNode | Subscribable<string>

Defined in: 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

Pick.label


listItemClasses?

optional listItemClasses: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:23

CSS class(es) to apply to the list item div element.


onDestroy()?

optional onDestroy: () => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:20

A callback function to execute when the list item is destroyed.

Returns

void

Overrides

Omit.onDestroy


onPressed()?

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

Defined in: garminsdk/components/touchbutton/TouchButton.tsx:109

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

Type Parameters

Type ParameterDefault type
B extends TouchButton<TouchButtonProps>TouchButton<TouchButtonProps>

Parameters

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

Returns

void

Inherited from

Pick.onPressed


paddedListItem?

optional paddedListItem: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListItem.tsx:20

Adds some default, commonly used padding to the list item. Defaults to false.

Inherited from

Omit.paddedListItem


ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

Omit.ref


touchButtonClasses?

optional touchButtonClasses: string | SubscribableSet<string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:26

CSS class(es) to apply to the list item div element.