Interface: HardwareControlListProps<T>
Properties on the ControlList component.
Type parameters
| Name |
|---|
T |
Hierarchy
↳
HardwareControlListProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
HardwareUiControlProps.children
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string
The CSS class to apply to this list container.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:36
data
• data: SubscribableArray<T>
The data associated with this list component.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:12
disableContainerScroll
• Optional disableContainerScroll: boolean
Disables automatically ensuring that the container scrolls to the focused item.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:42
getFocusPositionOnScroll
• Optional getFocusPositionOnScroll: (direction: ScrollDirection) => FocusPosition
A function which returns how the control should focus its children when it is focused from a scroll.
Type declaration
▸ (direction): FocusPosition
A function which returns how the control should focus its children when it is focused from a scroll.
Parameters
| Name | Type |
|---|---|
direction | ScrollDirection |
Returns
Inherited from
HardwareUiControlProps.getFocusPositionOnScroll
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:56
hideScrollbar
• Optional hideScrollbar: boolean
Whether or not to hide the list scrollbar.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:30
innerKnobScroll
• Optional innerKnobScroll: boolean
Whether or not the inner FMS knob scrolls also by default.
Inherited from
HardwareUiControlProps.innerKnobScroll
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:32
isolateScroll
• Optional isolateScroll: boolean
When enabled, scroll commands will not propagate from this control to its parent while the control is focused.
Inherited from
HardwareUiControlProps.isolateScroll
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:38
itemSize
• Optional itemSize: number
The size, in pixels, of each item in the list.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:24
numItems
• Optional numItems: number
The max number of items to display in the list.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:27
onAfterScroll
• Optional onAfterScroll: (control: HardwareUiControl<Record<string, any>, HardwareUiControlProps>, index: number) => void
An event called when the scroll operation has completed.
Type declaration
▸ (control, index): void
An event called when the scroll operation has completed.
Parameters
| Name | Type |
|---|---|
control | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
index | number |
Returns
void
Inherited from
HardwareUiControlProps.onAfterScroll
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:62
onBlurred
• Optional onBlurred: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when the control loses focus.
Type declaration
▸ (source): void
An event called when the control loses focus.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onBlurred
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:47
onDestroyed
• Optional onDestroyed: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when the control is destroyed.
Type declaration
▸ (source): void
An event called when the control is destroyed.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onDestroyed
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:71
onDisabled
• Optional onDisabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when the control is disabled.
Type declaration
▸ (source): void
An event called when the control is disabled.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onDisabled
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:50
onEnabled
• Optional onEnabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when the control is enabled.
Type declaration
▸ (source): void
An event called when the control is enabled.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onEnabled
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:53
onFocused
• Optional onFocused: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when the control is focused.
Type declaration
▸ (source): void
An event called when the control is focused.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onFocused
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:44
onItemSelected
• Optional onItemSelected: (data: null | T, node: null | HardwareUiControl<Record<string, any>, HardwareUiControlProps>, index: number) => void
A callback called when an item in the list is selected.
Type declaration
▸ (data, node, index): void
A callback called when an item in the list is selected.
Parameters
| Name | Type |
|---|---|
data | null | T |
node | null | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
index | number |
Returns
void
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:18
onRegistered
• Optional onRegistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when a control is registered with this control.
Type declaration
▸ (source): void
An event called when a control is registered with this control.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onRegistered
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:65
onScroll
• Optional onScroll: (direction: ScrollDirection) => boolean
An event called when the control is scrolled.
Type declaration
▸ (direction): boolean
An event called when the control is scrolled.
Parameters
| Name | Type |
|---|---|
direction | ScrollDirection |
Returns
boolean
Inherited from
HardwareUiControlProps.onScroll
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:59
onUnregistered
• Optional onUnregistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void
An event called when a control is unregistered with this control.
Type declaration
▸ (source): void
An event called when a control is unregistered with this control.
Parameters
| Name | Type |
|---|---|
source | HardwareUiControl<Record<string, any>, HardwareUiControlProps> |
Returns
void
Inherited from
HardwareUiControlProps.onUnregistered
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:68
orderBy
• Optional orderBy: (a: T, b: T) => number
Indicates that the list should be ordered by a specified function.
Type declaration
▸ (a, b): number
Indicates that the list should be ordered by a specified function.
Parameters
| Name | Type |
|---|---|
a | T |
b | T |
Returns
number
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:21
reconcileChildBlur
• Optional reconcileChildBlur: (index: number, child: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => number | BlurReconciliation
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.
Param
The index of the child control that was blurred.
Param
The child control that was blurred.
Type declaration
▸ (index, child): number | BlurReconciliation
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
| Name | Type | Description |
|---|---|---|
index | number | The index of the child control that was blurred. |
child | HardwareUiControl<Record<string, any>, HardwareUiControlProps> | 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
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:80
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
renderItem
• renderItem: (data: T, index: number) => VNode
A function that renders a single data item into the list.
Type declaration
▸ (data, index): VNode
A function that renders a single data item into the list.
Parameters
| Name | Type |
|---|---|
data | T |
index | number |
Returns
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:15
requireChildFocus
• Optional requireChildFocus: boolean
Whether the control requires one of its child controls to be focused for itself to be focused.
Inherited from
HardwareUiControlProps.requireChildFocus
Defined in
src/sdk/components/controls/HardwareUiControl.tsx:41
scrollContainer
• Optional scrollContainer: NodeReference<HTMLElement>
An alternate HTML element to scroll to ensure the selected element is in view.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:39
scrollToMostRecentlyAdded
• Optional scrollToMostRecentlyAdded: boolean
Scroll to the index of the most recently added item.
Defined in
src/sdk/components/controls/HardwareUiControlList.tsx:33