Skip to main content

Interface: GenericTabbedContentProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:19

Component props for GenericTabbedContent.

Extends

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

TabbedContentProps.children


isEnabled?

optional isEnabled: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:14

Whether the tab is enabled. Defaults to true.

Inherited from

TabbedContentProps.isEnabled


isVisible?

optional isVisible: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:17

Whether the tab is visible in the tab list. Defaults to true.

Inherited from

TabbedContentProps.isVisible


onAfterRender()?

optional onAfterRender: (thisNode, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:21

A function which is called after the content is rendered.

Parameters

ParameterType
thisNodeVNode
membersGenericTabbedContentMembers

Returns

void


onClose()?

optional onClose: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:39

A function which is called when the content is closed. Content is closed when it is deselected or its parent container is closed.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onDeselect()?

optional onDeselect: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:27

A function which is called when the content is deselected.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onDestroy()?

optional onDestroy: () => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:66

A function which is called when the content is destroyed.

Returns

void


onOpen()?

optional onOpen: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:33

A function which is called when the content is opened. Content is opened when it is selected and its parent container is open.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onPause()?

optional onPause: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:51

A function which is called when the content is paused. Content is paused when it is deselected or its parent container is paused.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onResume()?

optional onResume: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:45

A function which is called when the content is resumed. Content is resumed when it is selected and its parent container is resumed.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onSelect()?

optional onSelect: (members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:24

A function which is called when the content is selected to be displayed in its parent container.

Parameters

ParameterType
membersGenericTabbedContentMembers

Returns

void


onUiInteractionEvent()?

optional onUiInteractionEvent: (event, members) => boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:63

A function which handles UI interaction events routed to the content. If not defined, then the content will not handle any events.

Parameters

ParameterType
eventUiInteractionEvent
membersGenericTabbedContentMembers

Returns

boolean


onUpdate()?

optional onUpdate: (time, members) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:57

A function which is called when the content is updated. Content is updated when it is selected and its parent container is updated.

Parameters

ParameterType
timenumber
membersGenericTabbedContentMembers

Returns

void


ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

TabbedContentProps.ref


tabLabel

tabLabel: string | Subscribable<string> | () => VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:11

The label to display for the tab.

Inherited from

TabbedContentProps.tabLabel