Interface: HardwareUiControlProps

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:29

Properties on the UiControl2 component.

Extends

• ComponentProps

Extended by

• HardwareControlListProps

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children

---

getFocusPositionOnScroll()?

optional getFocusPositionOnScroll: (direction) => FocusPosition

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:56

A function which returns how the control should focus its children when it is focused from a scroll.

Parameters

Parameter	Type
direction	ScrollDirection

Returns

FocusPosition

---

innerKnobScroll?

optional innerKnobScroll: boolean

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:32

Whether or not the inner FMS knob scrolls also by default.

---

isolateScroll?

optional isolateScroll: boolean

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:38

When enabled, scroll commands will not propagate from this control to its parent while the control is focused.

---

onAfterScroll()?

optional onAfterScroll: (control, index) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:62

An event called when the scroll operation has completed.

Parameters

Parameter	Type
control	HardwareUiControl
index	number

Returns

void

---

onBlurred()?

optional onBlurred: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:47

An event called when the control loses focus.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onDestroyed()?

optional onDestroyed: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:71

An event called when the control is destroyed.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onDisabled()?

optional onDisabled: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:50

An event called when the control is disabled.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onEnabled()?

optional onEnabled: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:53

An event called when the control is enabled.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onFocused()?

optional onFocused: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:44

An event called when the control is focused.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onRegistered()?

optional onRegistered: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:65

An event called when a control is registered with this control.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

onScroll()?

optional onScroll: (direction) => boolean

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:59

An event called when the control is scrolled.

Parameters

Parameter	Type
direction	ScrollDirection

Returns

boolean

---

onUnregistered()?

optional onUnregistered: (source) => void

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:68

An event called when a control is unregistered with this control.

Parameters

Parameter	Type
source	HardwareUiControl

Returns

void

---

reconcileChildBlur()?

optional reconcileChildBlur: (index, child) => number | BlurReconciliation

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:80

A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.

Parameters

Parameter	Type	Description
index	number	The index of the child control that was blurred.
child	HardwareUiControl	The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child to focus, or a blur reconciliation strategy.

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

ComponentProps.ref

---

requireChildFocus?

optional requireChildFocus: boolean

Defined in: src/sdk/components/controls/HardwareUiControl.tsx:41

Whether the control requires one of its child controls to be focused for itself to be focused.