Skip to main content

Interface: TabbedContainerProps

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

Component props for TabbedContainer.

Extends​

  • ComponentProps

Properties​

bus?​

optional bus: EventBus

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

The event bus. Required for the container's tab list to respond appropriately to the mouse leaving the virtual cockpit instrument screen while the user is dragging the list.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

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

CSS class(es) to apply to the container's root element.

gduFormat​

gduFormat: GduFormat

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

The format of the container's parent GDU display.

knobLabel?​

optional knobLabel: string | Subscribable<string>

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

The bezel rotary knob label to request for the knobs that can be used to change the container's selected tab. Defaults to 'Select Tab'.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

tabLength​

tabLength: number | Subscribable<number>

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

The length of each tab along the axis along which the tabs are arranged, in pixels.

tabPosition​

tabPosition: "left" | "top" | "bottom" | "right"

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

The position of the container's tabs relative to the content box.

tabSpacing​

tabSpacing: number | Subscribable<number>

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

The spacing between each tab, in pixels. For best results, this value should be greater than or equal to the border radius of the tabs.

tabsPerListPage​

tabsPerListPage: number | Subscribable<number>

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

The maximum number of tabs visible at any one time in the container's tab list.

validKnobIds?​

optional validKnobIds: Iterable<UiKnobId>

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

The IDs of the valid bezel rotary knobs that can be used to change the container's selected tab. If not defined, then knobs cannot be used to change the container's selected tab.