Interface: UiListItemProps
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:16
Component props for UiListItem.
Extends
ComponentProps
Properties
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
ComponentProps.children
designatedChildDrivesFocusable?
optional
designatedChildDrivesFocusable:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:22
Whether the list item's designated focusable child determines whether the list item can be focused. If true
,
then the list item can be focused if and only if the designated child exists and can be focused. If false
, then
the list item can always be focused. Defaults to false
.
hideBorder?
optional
hideBorder:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:25
Whether to hide the list item's border. Defaults to false
.
onDestroy()?
optional
onDestroy: () =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:39
A callback function to execute when the list item is destroyed.
Returns
void
onFocusGained()?
optional
onFocusGained: (direction
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:31
A function which is called when the list item gains UI focus.
Parameters
Parameter | Type | Description |
---|---|---|
direction | UiFocusDirection | The direction from which the list item gained focus. |
Returns
void
onFocusLost()?
optional
onFocusLost: () =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:36
A function which is called when the list item loses UI focus.
Returns
void
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
ComponentProps.ref