.. Copyright (c) Jupyter Development Team.
.. Distributed under the terms of the Modified BSD License.

Notebook
========

Background
----------

.. _architecture-walkthrough:

A JupyterLab architecture walkthrough from June 16, 2016, provides an overview of the notebook architecture.

.. raw:: html

  <div class="jp-youtube-video">
     <iframe src="https://www.youtube-nocookie.com/embed/4Qm6oD_Rlw8?rel=0&amp;showinfo=0&amp;start=3326" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  </div>


The most complicated plugin included in the **JupyterLab application**
is the **Notebook plugin**.

The
`NotebookWidgetFactory <../api/classes/notebook.NotebookWidgetFactory-1.html>`__
constructs a new
`NotebookPanel <../api/classes/notebook.NotebookPanel-1.html>`__
from a model and populates the toolbar with default widgets.

Structure of the Notebook plugin
--------------------------------

The Notebook plugin provides a model and widgets for dealing with
notebook files.

Model
^^^^^

The
`NotebookModel <../api/classes/notebook.NotebookModel-1.html>`__
contains an observable list of cells.

A `cell
model <../api/classes/cells.CellModel-1.html>`__
can be:

-  a code cell
-  a markdown cell
-  raw cell

A code cell contains a list of **output models**. The list of cells and
the list of outputs can be observed for changes.

Cell operations
"""""""""""""""

The NotebookModel cell list supports single-step operations such as
moving, adding, or deleting cells. Compound cell list operations, such
as undo/redo, are also supported by the NotebookModel. Right now,
undo/redo is only supported on cells and is not supported on notebook
attributes, such as notebook metadata. Currently, undo/redo for
individual cell input content is supported by the CodeMirror editor's
undo feature. (Note: CodeMirror editor's undo does not cover cell
metadata changes.)

Metadata
""""""""

The notebook model and the cell model (i.e. notebook cells) support
getting and setting metadata through method ``getMetadata``, ``setMetadata``
and ``deleteMetadata`` (see `NotebookModel <../api/classes/notebook.NotebookModel-1.html>`__
and `cell model <../api/classes/cells.CellModel-1.html>`__).
You can listen for changes in the metadata through the ``sharedModel.metadataChanged`` attribute
(see `cell shared model <https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedBaseCell.html#metadataChanged>`__
and `notebook shared model <https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedNotebook-1.html#metadataChanged>`__).

Notebook widget
^^^^^^^^^^^^^^^

After the NotebookModel is created, the NotebookWidgetFactory constructs
a new NotebookPanel from the model. The NotebookPanel widget is added to
the DockPanel. The **NotebookPanel** contains:

-  a
   `Toolbar <../api/classes/ui_components.Toolbar-1.html>`__
-  a `Notebook
   widget <../api/classes/notebook.Notebook-1.html>`__.

The NotebookPanel also adds completion logic.

The **Notebook toolbar** maintains a list of widgets to add to the
toolbar. The **Notebook widget** contains the rendering of the notebook
and handles most of the interaction logic with the notebook itself (such
as keeping track of interactions such as selected and active cells and
also the current edit/command mode).

The NotebookModel cell list provides ways to do fine-grained changes to
the cell list.

Higher level actions using NotebookActions
""""""""""""""""""""""""""""""""""""""""""

Higher-level actions are contained in the
`NotebookActions <../api/classes/notebook.NotebookActions-1.html>`__
namespace, which has functions, when given a notebook widget, to run a
cell and select the next cell, merge or split cells at the cursor,
delete selected cells, etc.

Widget hierarchy
""""""""""""""""

A Notebook widget contains a list of `cell
widgets <../api/classes/cells.Cell-1.html>`__,
corresponding to the cell models in its cell list.

-  Each cell widget contains an
   `InputArea <../api/classes/cells.InputArea-1.html>`__,

   -  which contains a
      `CodeEditorWrapper <../api/classes/codeeditor.CodeEditorWrapper-1.html>`__,

      -  which contains a JavaScript CodeMirror instance.

A
`CodeCell <../api/classes/cells.CodeCell-1.html>`__
also contains an
`OutputArea <../api/classes/outputarea.OutputArea-1.html>`__.
An OutputArea is responsible for rendering the outputs in the
`OutputAreaModel <../api/classes/outputarea.OutputAreaModel-1.html>`__
list. An OutputArea uses a notebook-specific
`RenderMimeRegistry <../api/classes/rendermime.RenderMimeRegistry-1.html>`__
object to render ``display_data`` output messages.

The Notebook widget is represented in the DOM with a ``<div>`` element
with CSS classes ``jp-Notebook`` and ``jp-NotebookPanel-notebook``.
It contains a sequence of cells widgets.

 - Code cells have the following DOM structure:

   .. image:: images/code-cell-dom.svg

 - Rendered markdown cells have the following DOM structure:

   .. image:: images/rendered-markdown-cell-dom.svg

 - Active markdown cells have the following DOM structure:

   .. image:: images/active-markdown-cell-dom.svg

.. note::
   The default nbconvert template for the HTML exporter produces the same DOM
   as the JupyterLab notebook, allowing for the JupyterLab CSS to be used directly.
   In JupyterLab, input areas are rendered with the CodeMirror, with a custom theme
   making use of the CSS variables of JupyterLab.
   In the case of nbconvert, code cells are rendered using the Pygments Python
   library, which produces static HTML with syntax highlighting. The
   `jupyterlab_pygments <https://github.com/jupyterlab/jupyterlab_pygments.git>`_
   Pygments theme mimicks the default CodeMirror theme of JupyterLab.

.. note::
   The SVG figures presenting the DOM structures of the different cell types
   were produced with Draw.io, and contain the metadata allowing them to be
   directly opened and edited with Draw.io.

Rendering output messages
"""""""""""""""""""""""""

A **Rendermime plugin** provides a pluggable system for rendering output
messages. Default renderers are provided for markdown, html, images,
text, etc. Extensions can register renderers to be used across the
entire application by registering a handler and mimetype in the
rendermime registry. When a notebook is created, it copies the global
Rendermime singleton so that notebook-specific renderers can be added.
The ipywidgets widget manager is an example of an extension that adds a
notebook-specific renderer, since rendering a widget depends on
notebook-specific widget state.

Keyboard interaction model
""""""""""""""""""""""""""

Multiple elements can receive focus in the Notebook:
- the main toolbar,
- cells,
- cell components (editor, toolbar, outputs).

When the focus is outside of the cell input editor,
the Notebook switches to so-called "command" mode.
In the command mode additional keyboard shortcuts are accessible to the user,
enabling quick access to cell- and notebook-specific actions.
These shortcuts are only active when the notebook is in command mode
and the active element is non-editable,
as signalled by absence of ``.jp-mod-readWrite`` class on the notebook node.
This class is set if the active element is editable as ascertained by matching
to the ``:read-write`` pseudo-selector, and accounts for any elements nested
in the open shadow DOM, but not for the closed shadow DOM nor non-editable
elements with custom key event handlers (such as
``<div contenteditable="false" onkeydown="alert()" tabindex="0"></div>``).
If your output widget (for example created with ``IPython.display.HTML``,
or created by your MIME renderer on cell output in a notebook or console)
uses closed shadow DOM or non-editable elements with custom
key event handlers, you may wish to set ``lm-suppress-shortcuts`` data attribute
on the host element to prevent side-effects from the command-mode actions, e.g:

.. code:: html

   <div
     contenteditable="false"
     onkeydown="alert()"
     tabindex="1"
     data-lm-suppress-shortcuts="true"
   >
     Click on me and press "A" with and without "lm-suppress-shortcuts"
   </div>

.. _extend-notebook-plugin:

How to extend the Notebook plugin
---------------------------------

We'll walk through two notebook extensions:

-  adding a button to the toolbar
-  adding a widget to the notebook header
-  adding an ipywidgets extension

Adding a button to the toolbar
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Since JupyterLab 3.2, adding toolbar item can be done using a :ref:`toolbar-registry` and settings. In particular
for the notebook, if the button is linked to a new command, you can add a button in the toolbar using the
following JSON snippet in your extension settings file:

.. code:: js

   "jupyter.lab.toolbars": {
     "Notebook": [ // Widget factory name for which you want to add a toolbar item.
       // Item with default button widget triggering a command
       { "name": "run", "command": "runmenu:run" }
     ]
   }

You may add a ``rank`` attribute to modify the item position (the default value is 50).

Adding a widget to the notebook header
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Start from the extension template.

.. code-block:: shell

    pip install "copier~=8.0" jinja2-time
    mkdir myextension
    cd myextension
    copier copy --UNSAFE https://github.com/jupyterlab/extension-template .

Install the dependencies. Note that extensions are built against the
released npm packages, not the development versions.

.. code-block:: shell

    jlpm add -D @jupyterlab/notebook @jupyterlab/application @jupyterlab/ui-components @jupyterlab/docregistry @lumino/disposable @lumino/widgets

Copy the following to ``src/index.ts``:

.. code:: typescript

    import { IDisposable, DisposableDelegate } from '@lumino/disposable';

    import { Widget } from '@lumino/widgets';

    import {
      JupyterFrontEnd,
      JupyterFrontEndPlugin
    } from '@jupyterlab/application';

    import { DocumentRegistry } from '@jupyterlab/docregistry';

    import { NotebookPanel, INotebookModel } from '@jupyterlab/notebook';

    /**
    * The plugin registration information.
    */
    const plugin: JupyterFrontEndPlugin<void> = {
      activate,
      id: 'my-extension-name:widgetPlugin',
      description: 'Add a widget to the notebook header.',
      autoStart: true
    };

    /**
    * A notebook widget extension that adds a widget in the notebook header (widget below the toolbar).
    */
    export class WidgetExtension
      implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel>
    {
      /**
      * Create a new extension object.
      */
      createNew(
        panel: NotebookPanel,
        context: DocumentRegistry.IContext<INotebookModel>
      ): IDisposable {
        const widget = new Widget({ node: Private.createNode() });
        widget.addClass('jp-myextension-myheader');

        panel.contentHeader.insertWidget(0, widget);
        return new DisposableDelegate(() => {
          widget.dispose();
        });
      }
    }

    /**
    * Activate the extension.
    */
    function activate(app: JupyterFrontEnd): void {
      app.docRegistry.addWidgetExtension('Notebook', new WidgetExtension());
    }

    /**
    * Export the plugin as default.
    */
    export default plugin;

    /**
    * Private helpers
    */
    namespace Private {
      /**
      * Generate the widget node
      */
      export function createNode(): HTMLElement {
        const span = document.createElement('span');
        span.textContent = 'My custom header';
        return span;
      }
    }


And the following to ``style/base.css``:

.. code-block:: css

    .jp-myextension-myheader {
        min-height: 20px;
        background-color: lightsalmon;
    }


Run the following commands:

.. code-block:: shell

    pip install -e .
    jupyter labextension develop . --overwrite
    jupyter lab

Open a notebook and observe the new "Header" widget.

The *ipywidgets* third party-extension
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This discussion will be a bit confusing since we've been using the term
*widget* to refer to *lumino widgets*. In the discussion below,
*Jupyter interactive widgets* will be referred to as *ipywidgets*. There is no
intrinsic relation between *lumino widgets* and *Jupyter interactive widgets*.

The *ipywidgets* extension registers a factory for a notebook *widget*
extension using the `Document
Registry <../api/classes/docregistry.DocumentRegistry-1.html>`__.
The ``createNew()`` function is called with a NotebookPanel and
`DocumentContext <../api/interfaces/docregistry.DocumentRegistry.IContext.html>`__.
The plugin then creates a ipywidget manager (which uses the context to
interact the kernel and kernel's comm manager). The plugin then
registers an ipywidget renderer with the notebook instance's rendermime
(which is specific to that particular notebook).

When an ipywidget model is created in the kernel, a comm message is sent
to the browser and handled by the ipywidget manager to create a
browser-side ipywidget model. When the model is displayed in the kernel,
a ``display_data`` output is sent to the browser with the ipywidget
model id. The renderer registered in that notebook's rendermime is asked
to render the output. The renderer asks the ipywidget manager instance
to render the corresponding model, which returns a JavaScript promise.
The renderer creates a container *lumino widget* which it hands back
synchronously to the OutputArea, and then fills the container with the
rendered *ipywidget* when the promise resolves.
