Interface IEntry

Information about a plugin.

interface IEntry {
    autoStart?: boolean | "defer";
    description?: string;
    enabled: boolean;
    extension: string;
    id: string;
    locked: boolean;
    optional: JupyterLab.IToken[];
    provides: null | JupyterLab.IToken;
    requires: JupyterLab.IToken[];
    tokenLabel?: string;
}

Hierarchy (View Summary)

Properties

autoStart? description? enabled extension id locked optional provides requires tokenLabel?

Properties

Optional ReadonlyautoStart

autoStart?: boolean | "defer"

Whether the plugin should be activated on application start or waiting for being required. If the value is 'defer' then the plugin should be activated only after the application is started.

Notes

The default is false.

Optional Readonlydescription

description?: string

Plugin description.

Notes

This can be used to provide user documentation on the feature brought by a plugin.

enabled

enabled: boolean

Whether the plugin is enabled.

extension

extension: string

The name of the extension which provides the plugin.

Readonlyid

id: string

The human readable ID of the plugin.

Notes

This must be unique within an application.

Readonlylocked

locked: boolean

Whether the plugin is locked (cannot be enabled/disabled).

Administrators can lock plugins preventing users from introducing modifications. The check is performed on the server side, this field is only to show users an indicator of the lock status.

Readonlyoptional

optional: JupyterLab.IToken[]

The types of optional services for the the plugin, or [].

Readonlyprovides

provides: null | JupyterLab.IToken

The type of service provided by the plugin, or null.

Readonlyrequires

requires: JupyterLab.IToken[]

The types of required services for the plugin, or [].

OptionaltokenLabel

tokenLabel?: string

Token name (if any) excluding the plugin prefix (unless none)

Settings

Member Visibility

On This Page

Properties