Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

An options object for initializing a widget. An options object for initializing a tab panel.

Hierarchy

  • IOptions

Index

Properties

Optional addButtonEnabled

addButtonEnabled: undefined | false | true

Whether the button to add new tabs is enabled.

The default is false.

Optional document

document: Document | ShadowRoot

The document to use with the tab panel.

The default is the global document instance.

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 renderer

renderer: IRenderer<Widget>

The renderer for the panel's tab bar.

The default is a shared renderer instance.

Optional tabPlacement

tabPlacement: TabPlacement

The placement of the tab bar relative to the content.

The default is 'top'.

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.

Generated using TypeDoc