IOptions | @lumino/widgets

An options object for initializing a widget. An options object for creating a tab bar.

Type parameters

Hierarchy

IOptions

Index

Properties

Optional addButtonEnabled

addButtonEnabled: undefined | false | true

Whether the add button is enabled.

The default is false.

Optional allowDeselect

allowDeselect: undefined | false | true

Whether a tab can be deselected by the user.

The default is false.

Optional document

document: Document | ShadowRoot

The document to use with the tab bar.

The default is the global document instance.

Optional insertBehavior

insertBehavior: InsertBehavior

The selection behavior when inserting a tab.

The default is 'select-tab-if-needed'.

Optional name

name: undefined | string

Name of the tab bar.

This is used for accessibility reasons. The default is the empty string.

Optional node

node: HTMLElement

The optional node to use for the widget.

If a node is provided, the widget will assume full ownership and control of the node, as if it had created the node itself.

The default is a new <div>.

Optional orientation

orientation: Orientation

The layout orientation of the tab bar.

The default is horizontal.

Optional removeBehavior

removeBehavior: RemoveBehavior

The selection behavior when removing a tab.

The default is 'select-tab-after'.

Optional renderer

renderer: IRenderer<T>

A renderer to use with the tab bar.

The default is a shared renderer instance.

Optional tabsMovable

tabsMovable: undefined | false | true

Whether the tabs are movable by the user.

The default is false.

Optional tag

tag: keyof HTMLElementTagNameMap

The optional element tag, used for constructing the widget's node.

If a pre-constructed node is provided via the node arg, this value is ignored.

Optional titlesEditable

titlesEditable: undefined | false | true

Whether the titles can be directly edited by the user.

The default is false.