Interface: HardwareControlListProps<T>

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:9

Properties on the ControlList component.

Extends

• HardwareUiControlProps

Type Parameters

Type Parameter
T

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

HardwareUiControlProps.children

---

class?

optional class: string

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:36

The CSS class to apply to this list container.

---

data

data: SubscribableArray<T>

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:12

The data associated with this list component.

---

disableContainerScroll?

optional disableContainerScroll: boolean

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:42

Disables automatically ensuring that the container scrolls to the focused item.

---

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

Inherited from

HardwareUiControlProps.getFocusPositionOnScroll

---

hideScrollbar?

optional hideScrollbar: boolean

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:30

Whether or not to hide the list scrollbar.

---

innerKnobScroll?

optional innerKnobScroll: boolean

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

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

Inherited from

HardwareUiControlProps.innerKnobScroll

---

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.

Inherited from

HardwareUiControlProps.isolateScroll

---

itemSize?

optional itemSize: number

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:24

The size, in pixels, of each item in the list.

---

numItems?

optional numItems: number

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:27

The max number of items to display in the list.

---

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

Inherited from

HardwareUiControlProps.onAfterScroll

---

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

Inherited from

HardwareUiControlProps.onBlurred

---

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

Inherited from

HardwareUiControlProps.onDestroyed

---

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

Inherited from

HardwareUiControlProps.onDisabled

---

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

Inherited from

HardwareUiControlProps.onEnabled

---

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

Inherited from

HardwareUiControlProps.onFocused

---

onItemSelected()?

optional onItemSelected: (data, node, index) => void

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:18

A callback called when an item in the list is selected.

Parameters

Parameter	Type
data	null | T
node	null | HardwareUiControl<Record<string, any>, HardwareUiControlProps>
index	number

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

Inherited from

HardwareUiControlProps.onRegistered

---

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

Inherited from

HardwareUiControlProps.onScroll

---

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

Inherited from

HardwareUiControlProps.onUnregistered

---

orderBy()?

optional orderBy: (a, b) => number

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:21

Indicates that the list should be ordered by a specified function.

Parameters

Parameter	Type
a	T
b	T

Returns

number

---

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.

Inherited from

HardwareUiControlProps.reconcileChildBlur

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

HardwareUiControlProps.ref

---

renderItem()

renderItem: (data, index) => VNode

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:15

A function that renders a single data item into the list.

Parameters

Parameter	Type
data	T
index	number

Returns

VNode

---

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.

Inherited from

HardwareUiControlProps.requireChildFocus

---

scrollContainer?

optional scrollContainer: NodeReference<HTMLElement>

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:39

An alternate HTML element to scroll to ensure the selected element is in view.

---

scrollToMostRecentlyAdded?

optional scrollToMostRecentlyAdded: boolean

Defined in: src/sdk/components/controls/HardwareUiControlList.tsx:33

Scroll to the index of the most recently added item.