Class: UiListItem
An item meant to be rendered within a UI list as a list item. The item consists of a root container which can be focused by touching it. Additionally, one descendant of the item can be designated as a focusable component by wrapping it with a UiListFocusable. If a focusable component is designated, it will gain focus when the item gains focus and vice versa. If multiple descendants are wrapped with UiListFocusable, then only the first one found using a depth-first search will be designated.
By default, the item is highlighted with a cyan border when it is focused unless its designated focusable component is also focused.
Hierarchy
DisplayComponent<UiListItemProps>↳
UiListItem
Implements
Constructors
constructor
• new UiListItem(props): UiListItem
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | UiListItemProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<UiListItemProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
canBeFocused
• Readonly canBeFocused: Subscribable<boolean>
Inherit Doc
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:63
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
isUiFocusableComponent
• Readonly isUiFocusableComponent: true
Inherit Doc
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:54
props
• props: UiListItemProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:182
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(thisNode): void
Parameters
| Name | Type |
|---|---|
thisNode | VNode |
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:70
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onUiInteractionEvent
▸ onUiInteractionEvent(event): boolean
Handles a UiInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Implementation of
UiInteractionHandler.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:107
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:152