Interface: CombinedTouchButtonProps
Component props for CombinedTouchButton.
Hierarchy
ComponentProps↳
CombinedTouchButtonProps
Properties
canBeFocused
• Optional canBeFocused: boolean | Subscribable<boolean>
Whether the component can be focused. Ignored if isFocusable is false. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:33
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 component's root element.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:68
focusController
• Optional focusController: UiFocusController
A UI focus controller with which to automatically register the component after it is rendered. If not defined,
then the component will not be automatically registered with any controller, but it may still be registered
manually. Ignored if isFocusable is false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:30
focusSelfOnTouch
• Optional focusSelfOnTouch: boolean
Whether the combined button should attempt to focus itself when one of its child buttons is touched. Ignored if
isFocusable is false. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:39
isFocusable
• Optional isFocusable: boolean
Whether the combined button should be rendered as a focusable component. Defaults to false.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:23
onDeregistered
• Optional onDeregistered: (combinedButton: CombinedTouchButton, controller: UiFocusController) => void
A function which is called when the component is deregistered with a UI focus controller.
Type declaration
▸ (combinedButton, controller): void
A function which is called when the component is deregistered with a UI focus controller.
Parameters
| Name | Type |
|---|---|
combinedButton | CombinedTouchButton |
controller | UiFocusController |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:49
onFocusGained
• Optional onFocusGained: (combinedButton: CombinedTouchButton, direction: UiFocusDirection) => void
A function which is called when the component gains focus.
Type declaration
▸ (combinedButton, direction): void
A function which is called when the component gains focus.
Parameters
| Name | Type |
|---|---|
combinedButton | CombinedTouchButton |
direction | UiFocusDirection |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:54
onFocusLost
• Optional onFocusLost: (combinedButton: CombinedTouchButton) => void
A function which is called when the component loses focus.
Type declaration
▸ (combinedButton): void
A function which is called when the component loses focus.
Parameters
| Name | Type |
|---|---|
combinedButton | CombinedTouchButton |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:59
onRegistered
• Optional onRegistered: (combinedButton: CombinedTouchButton, controller: UiFocusController) => void
A function which is called when the component is registered with a UI focus controller.
Type declaration
▸ (combinedButton, controller): void
A function which is called when the component is registered with a UI focus controller.
Parameters
| Name | Type |
|---|---|
combinedButton | CombinedTouchButton |
controller | UiFocusController |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:44
onUiInteractionEvent
• Optional onUiInteractionEvent: (event: UiInteractionEvent) => boolean
A function which handles UiInteractionEvents routed to the component. If not defined, then the component will not handle any events.
Type declaration
▸ (event): boolean
A function which handles UiInteractionEvents routed to the component. If not defined, then the component will not handle any events.
Parameters
| Name | Type |
|---|---|
event | UiInteractionEvent |
Returns
boolean
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:65
orientation
• orientation: "col" | "row"
The direction along which the component's child buttons are arranged.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:20
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125