Interface CreateWindowOptions

Options for creating a plugin dialog window.

See also PluginAPI.CreateWindow.

interface CreateWindowOptions {
    className: string | string[];
    draggable: boolean;
    height: string;
    id: string;
    min_toggle: boolean;
    title: string;
    width: string;
    onclose(): unknown;
}

Properties

className draggable height id min_toggle title width

Methods

onclose

Properties

className

className: string | string[]

CSS class(es) for the created window.

draggable

draggable: boolean

Should it be possible to drag the window using the mouse?

height

height: string

Height of the window. The value can be any value that is allowed for the CSS height property of a <div> tag.

id

id: string

Unique DOM ID for the window. The IDs for the header div, the content div, close and minimize buttons are derived from this ID by adding _header, _content, _close, and _min, respectively.

min_toggle

min_toggle: boolean

Create a small button in the window headline which allows to collapse and maximize the window.

title

title: string

Title of the window.

width

width: string

Width of the window. The value can be any value that is allowed for the CSS width property of a <div> tag.

Methods

onclose

  • onclose(): unknown

  • Create a small close button in the window headline. The specified function is called when the close button is pressed.

    Returns unknown

Settings

Member Visibility

On This Page

Properties
Methods