Interface IOptions<T>

An options object for creating an application.

interface IOptions<T> {
    contextMenuRenderer?: Menu.IRenderer;
    pluginRegistry?: PluginRegistry<any>;
    shell: T;
    validatePlugin?: ((plugin) => boolean);
}

Type Parameters

Hierarchy (view full)

Properties

contextMenuRenderer? pluginRegistry? shell validatePlugin?

Properties

Optional contextMenuRenderer

contextMenuRenderer?: Menu.IRenderer

A custom renderer for the context menu.

Optional pluginRegistry

pluginRegistry?: PluginRegistry<any>

Application plugin registry.

If defined the options related to the plugin registry will be ignored.

shell

shell: T

The shell widget to use for the application.

This should be a newly created and initialized widget.

The application will attach the widget to the DOM.

Optional validatePlugin

validatePlugin?: ((plugin) => boolean)

Validate that a plugin is allowed to be registered.

Default is () => true.

Type declaration

    • (plugin): boolean

    • Parameters

      • plugin: IPlugin<any, any>

        The plugin to validate

      Returns boolean

Returns

Whether the plugin can be registered or not.

Notes

We recommend you print a console message with the reason a plugin is invalid.

Settings

Member Visibility

Theme

On This Page

contextMenuRendererpluginRegistryshellvalidatePlugin