Interface: CombinedTouchButtonProps
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:18
Component props for CombinedTouchButton.
Extends
ComponentProps
Properties
canBeFocused?
optional
canBeFocused:boolean
|Subscribable
<boolean
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:33
Whether the component can be focused. Ignored if isFocusable
is false
. Defaults to false
.
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
ComponentProps.children
class?
optional
class:string
|ToggleableClassNameRecord
|SubscribableSet
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:68
CSS class(es) to apply to the component's root element.
focusController?
optional
focusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:30
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
.
focusSelfOnTouch?
optional
focusSelfOnTouch:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:39
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
.
isFocusable?
optional
isFocusable:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:23
Whether the combined button should be rendered as a focusable component. Defaults to false
.
onDeregistered()?
optional
onDeregistered: (combinedButton
,controller
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:49
A function which is called when the component is deregistered with a UI focus controller.
Parameters
Parameter | Type |
---|---|
combinedButton | CombinedTouchButton |
controller | UiFocusController |
Returns
void
onFocusGained()?
optional
onFocusGained: (combinedButton
,direction
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:54
A function which is called when the component gains focus.
Parameters
Parameter | Type |
---|---|
combinedButton | CombinedTouchButton |
direction | UiFocusDirection |
Returns
void
onFocusLost()?
optional
onFocusLost: (combinedButton
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:59
A function which is called when the component loses focus.
Parameters
Parameter | Type |
---|---|
combinedButton | CombinedTouchButton |
Returns
void
onRegistered()?
optional
onRegistered: (combinedButton
,controller
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:44
A function which is called when the component is registered with a UI focus controller.
Parameters
Parameter | Type |
---|---|
combinedButton | CombinedTouchButton |
controller | UiFocusController |
Returns
void
onUiInteractionEvent()?
optional
onUiInteractionEvent: (event
) =>boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:65
A function which handles UiInteractionEvents routed to the component. If not defined, then the component will not handle any events.
Parameters
Parameter | Type |
---|---|
event | UiInteractionEvent |
Returns
boolean
orientation
orientation:
"col"
|"row"
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:20
The direction along which the component's child buttons are arranged.
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
ComponentProps.ref