This is a migration guide for updating extensions that support JupyterLab 1.x to work in JupyterLab 2.x. We will look at two examples of extensions that cover most of the APIs that extension authors might be using:
@jupyterlab/debuggermigration pull request: https://github.com/jupyterlab/debugger/pull/337/files@jupyterlab/shortcutuimigration pull request: https://github.com/jupyterlab/jupyterlab-shortcutui/pull/53/files
The @phosphor/* libraries that JupyterLab 1.x uses have been renamed to @lumino/*. Updating your package.json is straightforward. The easiest way to do this is to look in the JupyterLab core packages code base and to simply adopt the versions of the relevant libraries that are used there.
package.json
package.json
Tip
In these examples, note that we are using the 2.0.0-beta.x version of many libraries. This was to test the extensions against the JupyterLab 2.0 beta release before the final version. For the final release, your package.json should depend on version ^2.0.0 of these packages.
The foundational packages used by JupyterLab are now all prefixed with the NPM namespace @lumino instead of @phosphor. The APIs for these packages have not changed. The @phosphor namespaced imports need to be updated to the new @lumino namespaced packages:
@phosphor/... to @lumino/...@phosphor/application |
@lumino/application |
@phosphor/collections |
@lumino/collections |
@phosphor/commands |
@lumino/commands |
@phosphor/coreutils |
@lumino/coreutils |
@phosphor/datagrid |
@lumino/datagrid |
@phosphor/datastore |
@lumino/datastore |
@phosphor/default-theme |
@lumino/default-theme |
@phosphor/disposable |
@lumino/disposable |
@phosphor/domutils |
@lumino/domutils |
@phosphor/dragdrop |
@lumino/dragdrop |
@phosphor/keyboard |
@lumino/keyboard |
@phosphor/messaging |
@lumino/messaging |
@phosphor/properties |
@lumino/properties |
@phosphor/signaling |
@lumino/signaling |
@phosphor/virtualdom |
@lumino/virtualdom |
@phosphor/widgets |
@lumino/widgets |
Warning
p- prefixed CSS classes, data-p- attributes and p- DOM events are deprecated. They will continue to work until the next major release of Lumino.
.p-CSS classes such as.p-Widgetshould be updated to.lm-, e.g..lm-Widgetdata-p-attributes such asdata-p-dragscrollshould be updated todata-lm-, e.g.data-lm-dragscrollp-DOM events such asp-dragentershould be updated tolm-, e.g.lm-dragenter
JupyterLab 2.0 introduces several new packages with classes and tokens that have been moved out of @jupyterlab/coreutils into their own packages. These exports have been moved.
Tip
It might be helpful to delete node_modules and yarn.lock when updating these libraries.
| Export | Package |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note
For full API documentation and examples of how to use @jupyterlab/services, consult the repository.
ConsolePanel and NotebookPanel now expose a sessionContext: ISessionContext attribute that allows for a uniform way to interact with kernel sessions.
Any widget that matches the interface IDocumentWidget has a context: DocumentRegistry.IContext attribute with a sessionContext: ISessionContext attribute.
For example, consider how the @jupyterlab/debugger extension's DebuggerService updated its isAvailable() method.
Note
One notable change: await client.kernel.ready is no longer necessary. Using the new API (and optional chaining in TypeScript 3.7+), you can simply: await sessionContext.session?.kernel?.info to check when a kernel is ready and retrieve its details. --jupyterlab/debugger#337
Note
For full API documentation and examples of how to use the new icon support based on LabIcon from @jupyterlab/ui-components, consult the repository.