Interface IOptionsOptionalContent<T>

An options object for main area widget subclasses providing their own default content.

Notes

This makes it easier to have a subclass that provides its own default content. This can go away once we upgrade to TypeScript 2.8 and have an easy way to make a single property optional, ala https://stackoverflow.com/a/46941824

interface IOptionsOptionalContent<T> {
    content?: T;
    node?: HTMLElement;
    reveal?: Promise<any>;
    tag?: keyof HTMLElementTagNameMap;
    toolbar?: Toolbar<Widget>;
}

Type Parameters

Hierarchy

  • IOptions
    • IOptionsOptionalContent

    Properties

    content? node? reveal? tag? toolbar?

    Properties

    Optional content

    content?: T

    The child widget to wrap.

    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 reveal

    reveal?: Promise<any>

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

    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 toolbar

    toolbar?: Toolbar<Widget>

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

    Settings

    Member Visibility

    Theme

    On This Page

    contentnoderevealtagtoolbar