Where is a docs for Jupyter front-end extensions JavaScript API?

Question

I've read the docs about writing the Jupyter front-end extensions, and learn the examples, and now can build the simple extension by myself.

But - where is a complete docs for Jupyter extensions JavaScript API? How to find the JavaScript API for notebook properties and methods?

Answer 1

For newcomers it might be confusing that there are several projects with similar names for historical reasons:

a) Jupyter
https://github.com/jupyter

b) JupyterLab
https://github.com/jupyterlab/

The webpage https://jupyter.org/ references the newer b). However, the sub projects of a) do not include deprecation warnings.

=> If you find some documentation via search engine, you have to be careful if its related to a) or b).

Current documentation for JupyterLab extensions can be found here:

• General info: https://jupyterlab.readthedocs.io/en/3.2.x/user/extensions.html

• Javascript API doc: https://jupyterlab.readthedocs.io/en/stable/api/modules.html

• Examples: https://github.com/jupyterlab/extension-examples

• Discussion forum: https://discourse.jupyter.org/c/jupyterlab/extensions/

Related:

https://www.quora.com/What-is-the-difference-between-JupyterLab-and-Jupyter-Notebook-Is-there-a-use-case-for-one-over-the-other?share=1

https://github.com/jupyterlab/jupyterlab-plugin-playground

Answer 2

Apparently, there are is no front-end API documentation, as there is an open GitHub issue that even references your SO question. Maybe a few +1s on the issue might change this, although I suspect that the answer (if any) will point to JupyterLab, which has a defined front-end API but has no common technical base with Jupyter Notebook front-end extensions.