TabbedPanel

class

Back to Helios Web API

Kind

class

Source

src/ui/panels/TabbedPanel.js:24

Description

Small tabbed panel primitive used by the optional Helios UI.

Signature

export class TabbedPanel {

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional		Tab panel options.
|tabs	Array.<Object>	optional		Initial tabs.
|activeId	string	optional		Initially active tab id.

Lifecycle

Creation, initialization, prewarming, cleanup, and renderer lifetime.

destroy()

Source: src/ui/panels/TabbedPanel.js:100

Manages destroy for the current instance.

Configuration

General configuration setters and compatibility helpers.

setActive(id) → {this}

Source: src/ui/panels/TabbedPanel.js:79

Set the active setting.

Parameters

Name	Type	Attributes	Default	Description
id				Value passed to setActive.

Returns

This instance.

Type this

Utilities

Additional public helpers that do not belong to a narrower API area.

addTab(tab) → {this}

Source: src/ui/panels/TabbedPanel.js:57

Manages tab for the current instance.

Parameters

Name	Type	Attributes	Default	Description
tab				Value passed to addTab.

Returns

This instance.

Type this

activeId()

Source: src/ui/panels/TabbedPanel.js:96

Configures or reads active id.