Interface IOptions<T>

An options object for creating a main area widget.

interface IOptions<T extends Widget = Widget> {
    content: T;
    contentHeader?: BoxPanel;
    node?: HTMLElement;
    reveal?: Promise<any>;
    tag?: keyof HTMLElementTagNameMap;
    toolbar?: Toolbar<Widget>;
    translator?: ITranslator;
}

Type Parameters

Hierarchy (View Summary)

Properties

content contentHeader? node? reveal? tag? toolbar? translator?

Properties

content

content: T

The child widget to wrap.

OptionalcontentHeader

contentHeader?: BoxPanel

The layout to sit underneath the toolbar and above the content, and that extensions can populate. Defaults to an empty BoxPanel.

Optionalnode

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>.

Optionalreveal

reveal?: Promise<any>

An optional promise for when the content is ready to be revealed.

Optionaltag

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.

Optionaltoolbar

toolbar?: Toolbar<Widget>

The toolbar to use for the widget. Defaults to an empty toolbar.

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties