Interface: GenericUiFocusableComponentProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:10

Component props for GenericUiFocusableComponent.

Extends

• ComponentProps

Properties

canBeFocused?

optional canBeFocused: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:12

Whether the component can be focused. Defaults to true.

---

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children

---

onAfterRender()?

optional onAfterRender: (thisNode) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:15

A function which is called after the component is rendered.

Parameters

Parameter	Type
thisNode	VNode

Returns

void

---

onDeregistered()?

optional onDeregistered: (controller) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:21

A function which is called when the component is deregistered with a controller.

Parameters

Parameter	Type
controller	UiFocusController

Returns

void

---

onDestroy()?

optional onDestroy: () => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:36

A function which is called when the component is destroyed.

Returns

void

---

onFocusGained()?

optional onFocusGained: (direction) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:24

A function which is called when the component gains focus.

Parameters

Parameter	Type
direction	UiFocusDirection

Returns

void

---

onFocusLost()?

optional onFocusLost: () => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:27

A function which is called when the component loses focus.

Returns

void

---

onRegistered()?

optional onRegistered: (controller) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:18

A function which is called when the component is registered with a controller.

Parameters

Parameter	Type
controller	UiFocusController

Returns

void

---

onUiInteractionEvent()?

optional onUiInteractionEvent: (event) => boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/GenericUiFocusableComponent.tsx:33

A function which handles interaction events routed to the component. If not defined, then the component will not handle any events.

Parameters

Parameter	Type
event	UiInteractionEvent

Returns

boolean

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

ComponentProps.ref