Interface: GtcListButtonProps
The props for GtcListButton.
Hierarchy
Omit<GtcListItemProps,"class">Pick<GtcTouchButtonProps,"isEnabled"|"isHighlighted"|"onPressed"|"label"|"gtcOrientation">↳
GtcListButtonProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Omit.children
Defined in
sdk/components/FSComponent.ts:122
fullSizeButton
• Optional fullSizeButton: boolean
Whether the button should fill the entire list item. Overrides hideBorder to be true when true. Defaults to false.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListButton.tsx:14
gtcOrientation
• Optional gtcOrientation: GtcOrientation
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
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcTouchButton.tsx:34
hideBorder
• Optional hideBorder: boolean | Subscribable<boolean>
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
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListItem.tsx:14
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
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
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
garminsdk/components/touchbutton/TouchButton.tsx:94
listItemClasses
• Optional listItemClasses: string | SubscribableSet<string>
CSS class(es) to apply to the list item div element.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListButton.tsx:20
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
Overrides
Omit.onDestroy
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListButton.tsx:17
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 TouchButton<TouchButtonProps> = TouchButton<TouchButtonProps> |
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
garminsdk/components/touchbutton/TouchButton.tsx:109
paddedListItem
• Optional paddedListItem: boolean | Subscribable<boolean>
Adds some default, commonly used padding to the list item. Defaults to false.
Inherited from
Omit.paddedListItem
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListItem.tsx:20
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Omit.ref
Defined in
sdk/components/FSComponent.ts:125
touchButtonClasses
• Optional touchButtonClasses: string | SubscribableSet<string>
CSS class(es) to apply to the list item div element.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcListButton.tsx:23