ShellHub

Controls the shell. Extends MessageHub.

Overview

If you are using the standard Dirigible view configuration, shell hub support is automatically enabled.

If you are making a custom view, you can include the API using the web link above.

To initialize it:

const shellHub = new ShellHub();

Functions

Function	Description	Returns
showPerspective(IdParamObject)	Shows a perspective.	-
onShowPerspective(handlerFunc)	Registers a listener. Triggered when a perspective should be shown. Returns a function to unregister the listener.	function

Note

Params in square brackets are optional.

Properties

Param	Type	Description
id	`string`	Perspective id.
[params]	`object`	Custom parameters. See ViewParameters.

shellHub.openView({
    id: 'exampleView',
    params: {
        title: 'Example',
    }
});