@jupyterlite

@jupyterlite / @jupyterlite/application / SingleWidgetApp / IOptions

Interface: IOptions#

Defined in: packages/application/src/singleWidgetApp.ts:99

The instantiation options for an App application.

Extends#

Properties#

commandLinker?#

optional commandLinker: CommandLinker

Defined in: node_modules/@jupyterlab/application/lib/frontend.d.ts:111

The command linker used by the application.

Inherited from#

JupyterFrontEnd.IOptions.commandLinker

contextMenuRenderer?#

optional contextMenuRenderer: IRenderer

Defined in: node_modules/@lumino/application/types/index.d.ts:307

A custom renderer for the context menu.

Inherited from#

JupyterFrontEnd.IOptions.contextMenuRenderer

docRegistry?#

optional docRegistry: DocumentRegistry

Defined in: node_modules/@jupyterlab/application/lib/frontend.d.ts:107

The document registry instance used by the application.

Inherited from#

JupyterFrontEnd.IOptions.docRegistry

mimeExtensions?#

readonly optional mimeExtensions: IExtensionModule[]

Defined in: packages/application/src/singleWidgetApp.ts:110

The mime renderer extensions.

Inherited from#

Partial.mimeExtensions

pluginRegistry?#

optional pluginRegistry: PluginRegistry<any>

Defined in: node_modules/@lumino/application/types/index.d.ts:314

Application plugin registry.

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

Inherited from#

JupyterFrontEnd.IOptions.pluginRegistry

restored?#

optional restored: Promise<any>

Defined in: node_modules/@jupyterlab/application/lib/frontend.d.ts:120

Promise that resolves when state is first restored, returning layout description.

Inherited from#

JupyterFrontEnd.IOptions.restored

serviceManager?#

optional serviceManager: IManager

Defined in: node_modules/@jupyterlab/application/lib/frontend.d.ts:115

The service manager used by the application.

Inherited from#

JupyterFrontEnd.IOptions.serviceManager

shell#

Defined in: node_modules/@lumino/application/types/index.d.ts:303

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.

Inherited from#

JupyterFrontEnd.IOptions.shell

validatePlugin()?#

optional validatePlugin: (plugin) => boolean

Defined in: node_modules/@lumino/coreutils/types/plugins.d.ts:277

Validate that a plugin is allowed to be registered.

Default is () => true.

Parameters#

plugin#

IPlugin<any, any>

The plugin to validate

Returns#

boolean

Whether the plugin can be registered or not.

Notes#

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

Inherited from#

JupyterFrontEnd.IOptions.validatePlugin