@jupyterlab/notebook-extension 4.6.0-alpha.3 → 4.6.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/notebook-extension",
-  "version": "4.6.0-alpha.3",
+  "version": "4.6.0-alpha.5",
   "description": "JupyterLab - Notebook Extension",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -37,36 +37,36 @@
   },
   "dependencies": {
     "@jupyter/ydoc": "^3.1.0",
-    "@jupyterlab/application": "^4.6.0-alpha.3",
-    "@jupyterlab/apputils": "^4.7.0-alpha.3",
-    "@jupyterlab/cell-toolbar": "^4.6.0-alpha.3",
-    "@jupyterlab/cells": "^4.6.0-alpha.3",
-    "@jupyterlab/codeeditor": "^4.6.0-alpha.3",
-    "@jupyterlab/codemirror": "^4.6.0-alpha.3",
-    "@jupyterlab/completer": "^4.6.0-alpha.3",
-    "@jupyterlab/coreutils": "^6.6.0-alpha.3",
-    "@jupyterlab/docmanager": "^4.6.0-alpha.3",
-    "@jupyterlab/docmanager-extension": "^4.6.0-alpha.3",
-    "@jupyterlab/docregistry": "^4.6.0-alpha.3",
-    "@jupyterlab/documentsearch": "^4.6.0-alpha.3",
-    "@jupyterlab/filebrowser": "^4.6.0-alpha.3",
-    "@jupyterlab/launcher": "^4.6.0-alpha.3",
-    "@jupyterlab/logconsole": "^4.6.0-alpha.3",
-    "@jupyterlab/lsp": "^4.6.0-alpha.3",
-    "@jupyterlab/mainmenu": "^4.6.0-alpha.3",
-    "@jupyterlab/metadataform": "^4.6.0-alpha.3",
-    "@jupyterlab/nbformat": "^4.6.0-alpha.3",
-    "@jupyterlab/notebook": "^4.6.0-alpha.3",
-    "@jupyterlab/observables": "^5.6.0-alpha.3",
-    "@jupyterlab/property-inspector": "^4.6.0-alpha.3",
-    "@jupyterlab/rendermime": "^4.6.0-alpha.3",
-    "@jupyterlab/services": "^7.6.0-alpha.3",
-    "@jupyterlab/settingregistry": "^4.6.0-alpha.3",
-    "@jupyterlab/statedb": "^4.6.0-alpha.3",
-    "@jupyterlab/statusbar": "^4.6.0-alpha.3",
-    "@jupyterlab/toc": "^6.6.0-alpha.3",
-    "@jupyterlab/translation": "^4.6.0-alpha.3",
-    "@jupyterlab/ui-components": "^4.6.0-alpha.3",
+    "@jupyterlab/application": "^4.6.0-alpha.5",
+    "@jupyterlab/apputils": "^4.7.0-alpha.5",
+    "@jupyterlab/cell-toolbar": "^4.6.0-alpha.5",
+    "@jupyterlab/cells": "^4.6.0-alpha.5",
+    "@jupyterlab/codeeditor": "^4.6.0-alpha.5",
+    "@jupyterlab/codemirror": "^4.6.0-alpha.5",
+    "@jupyterlab/completer": "^4.6.0-alpha.5",
+    "@jupyterlab/coreutils": "^6.6.0-alpha.5",
+    "@jupyterlab/docmanager": "^4.6.0-alpha.5",
+    "@jupyterlab/docmanager-extension": "^4.6.0-alpha.5",
+    "@jupyterlab/docregistry": "^4.6.0-alpha.5",
+    "@jupyterlab/documentsearch": "^4.6.0-alpha.5",
+    "@jupyterlab/filebrowser": "^4.6.0-alpha.5",
+    "@jupyterlab/launcher": "^4.6.0-alpha.5",
+    "@jupyterlab/logconsole": "^4.6.0-alpha.5",
+    "@jupyterlab/lsp": "^4.6.0-alpha.5",
+    "@jupyterlab/mainmenu": "^4.6.0-alpha.5",
+    "@jupyterlab/metadataform": "^4.6.0-alpha.5",
+    "@jupyterlab/nbformat": "^4.6.0-alpha.5",
+    "@jupyterlab/notebook": "^4.6.0-alpha.5",
+    "@jupyterlab/observables": "^5.6.0-alpha.5",
+    "@jupyterlab/property-inspector": "^4.6.0-alpha.5",
+    "@jupyterlab/rendermime": "^4.6.0-alpha.5",
+    "@jupyterlab/services": "^7.6.0-alpha.5",
+    "@jupyterlab/settingregistry": "^4.6.0-alpha.5",
+    "@jupyterlab/statedb": "^4.6.0-alpha.5",
+    "@jupyterlab/statusbar": "^4.6.0-alpha.5",
+    "@jupyterlab/toc": "^6.6.0-alpha.5",
+    "@jupyterlab/translation": "^4.6.0-alpha.5",
+    "@jupyterlab/ui-components": "^4.6.0-alpha.5",
     "@lumino/algorithm": "^2.0.4",
     "@lumino/commands": "^2.3.3",
     "@lumino/coreutils": "^2.2.2",

package/schema/tools.json

@@ -28,6 +28,21 @@
               }
             ]
           },
+          "/deletable": {
+            "title": "Deletable",
+            "type": "boolean",
+            "default": true,
+            "oneOf": [
+              {
+                "const": true,
+                "title": "Deletable"
+              },
+              {
+                "const": false,
+                "title": "Not deletable"
+              }
+            ]
+          },
           "/slideshow/slide_type": {
             "title": "Slide Type",
             "type": "string",
@@ -99,6 +114,9 @@
       "uiSchema": {
         "/editable": {
           "ui:widget": "select"
+        },
+        "/deletable": {
+          "ui:widget": "select"
         }
       },
       "metadataOptions": {

package/schema/tracker.json

@@ -316,15 +316,13 @@
         "rank": 20
       },
       {
-        "command": "notebook:enable-output-scrolling",
+        "command": "notebook:toggle-output-scrolling",
+        "args": {
+          "isMenu": true
+        },
         "selector": ".jp-Notebook",
         "rank": 21
       },
-      {
-        "command": "notebook:disable-output-scrolling",
-        "selector": ".jp-Notebook",
-        "rank": 22
-      },
       {
         "type": "separator",
         "selector": ".jp-Notebook",
@@ -379,32 +377,32 @@
     {
       "command": "notebook:change-cell-to-heading-1",
       "keys": ["1"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-heading-2",
       "keys": ["2"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-heading-3",
       "keys": ["3"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-heading-4",
       "keys": ["4"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-heading-5",
       "keys": ["5"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-heading-6",
       "keys": ["6"],
-      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) :focus"
+      "selector": ".jp-Notebook.jp-mod-commandMode:not(.jp-mod-readWrite) .jp-MarkdownCell:focus"
     },
     {
       "command": "notebook:change-cell-to-markdown",

package/src/index.ts

@@ -66,6 +66,7 @@ import { IMetadataFormProvider } from '@jupyterlab/metadataform';
 import type * as nbformat from '@jupyterlab/nbformat';
 import type { Notebook } from '@jupyterlab/notebook';
 import {
+  CellCounterStatus,
   CommandEditStatus,
   ExecutionIndicator,
   INotebookCellExecutor,
@@ -312,6 +313,8 @@ namespace CommandIDs {
 
   export const disableOutputScrolling = 'notebook:disable-output-scrolling';
 
+  export const toggleOutputScrolling = 'notebook:toggle-output-scrolling';
+
   export const selectLastRunCell = 'notebook:select-last-run-cell';
 
   export const replaceSelection = 'notebook:replace-selection';
@@ -390,11 +393,11 @@ const trackerPlugin: JupyterFrontEndPlugin<INotebookTracker> = {
 };
 
 /**
- * The notebook cell factory provider.
+ * The notebook and cell factory provider.
  */
 const factory: JupyterFrontEndPlugin<NotebookPanel.IContentFactory> = {
   id: '@jupyterlab/notebook-extension:factory',
-  description: 'Provides the notebook cell factory.',
+  description: 'Provides the notebook and cell factory.',
   provides: NotebookPanel.IContentFactory,
   requires: [IEditorServices],
   autoStart: true,
@@ -464,6 +467,50 @@ export const commandEditItem: JupyterFrontEndPlugin<void> = {
   }
 };
 
+/**
+ * A plugin providing a current cell/total cells status item.
+ */
+export const cellCounterItem: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/notebook-extension:cell-counter-status',
+  description: 'Adds a notebook cell counter status widget.',
+  autoStart: true,
+  requires: [INotebookTracker, ITranslator],
+  optional: [IStatusBar],
+  activate: (
+    app: JupyterFrontEnd,
+    tracker: INotebookTracker,
+    translator: ITranslator,
+    statusBar: IStatusBar | null
+  ) => {
+    if (!statusBar) {
+      // Automatically disable if statusbar missing
+      return;
+    }
+
+    const { shell } = app;
+    const item = new CellCounterStatus({ translator });
+
+    const updateNotebook = () => {
+      const current = tracker.currentWidget;
+      item.model.notebook = current && current.content;
+    };
+
+    tracker.currentChanged.connect(updateNotebook);
+    updateNotebook();
+
+    statusBar.registerStatusItem(cellCounterItem.id, {
+      priority: 1,
+      item,
+      align: 'right',
+      rank: 2.5,
+      isActive: () =>
+        !!shell.currentWidget &&
+        !!tracker.currentWidget &&
+        shell.currentWidget === tracker.currentWidget
+    });
+  }
+};
+
 /**
  * A plugin that provides a execution indicator item to the status bar.
  */
@@ -691,7 +738,8 @@ export const exportPlugin: JupyterFrontEndPlugin<void> = {
       // Convert export list to palette and menu items.
       const formatList = Object.keys(response);
       formatList.forEach(function (key) {
-        const capCaseKey = trans.__(key[0].toUpperCase() + key.substr(1));
+        const formattedKey = key[0].toLocaleUpperCase() + key.slice(1);
+        const capCaseKey = trans.__(formattedKey);
         const labelStr = formatLabels[key] ? formatLabels[key] : capCaseKey;
         let args = {
           format: key,
@@ -1027,7 +1075,8 @@ const updateRawMimetype: JupyterFrontEndPlugin<void> = {
             value => value.const === key
           ).length > 0;
         if (!mimetypeExists) {
-          const altOption = trans.__(key[0].toUpperCase() + key.substr(1));
+          const formattedKey = key[0].toLocaleUpperCase() + key.slice(1);
+          const altOption = trans.__(formattedKey);
           const option = formatLabels[key] ? formatLabels[key] : altOption;
           const mimeTypeValue = response[key].output_mimetype;
 
@@ -1203,6 +1252,7 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   executionIndicator,
   exportPlugin,
   tools,
+  cellCounterItem,
   commandEditItem,
   notebookTrustItem,
   widgetFactoryPlugin,
@@ -1613,7 +1663,7 @@ function activateCodeConsole(
         let fromFirst = curLine > 0;
         let firstLine = 0;
         let lastLine = firstLine + 1;
-        // eslint-disable-next-line
+
         while (true) {
           code = srcLines.slice(firstLine, lastLine).join('\n');
           const reply =
@@ -2014,6 +2064,8 @@ function activateNotebookHandler(
     // If the notebook panel does not have an ID, assign it one.
     widget.id = widget.id || `notebook-${++id}`;
 
+    widget.content.node.setAttribute('data-trust-command', CommandIDs.trust);
+
     // Set up the title icon
     widget.title.icon = ft?.icon;
     widget.title.iconClass = ft?.iconClass ?? '';
@@ -2426,6 +2478,25 @@ function getCurrent(
   return widget;
 }
 
+// Whether all selected code cells have output scrolling enabled.
+function isOutputScrollingEnabled(notebook: Notebook): boolean {
+  if (!notebook.model || !notebook.activeCell) {
+    return false;
+  }
+
+  let hasCodeCell = false;
+  for (const cell of notebook.widgets) {
+    if (notebook.isSelectedOrActive(cell) && cell.model.type === 'code') {
+      hasCodeCell = true;
+      if (!(cell as CodeCell).outputsScrolled) {
+        return false;
+      }
+    }
+  }
+
+  return hasCodeCell;
+}
+
 /**
  * Add the notebook commands to the application's command registry.
  */
@@ -2450,6 +2521,11 @@ function addCommands(
         cell
           .getHeadings()
           .then(() => {
+            // Heading parsing is async; avoid restoring an outdated collapse
+            // state if the heading has been expanded in the meantime.
+            if (cell.isDisposed || !cell.headingCollapsed) {
+              return;
+            }
             NotebookActions.setHeadingCollapse(cell, true, notebook);
           })
           .catch(error => {
@@ -2518,6 +2594,7 @@ function addCommands(
     commands.notifyCommandChanged(CommandIDs.runAndInsert);
   });
   tracker.activeCellChanged.connect(() => {
+    commands.notifyCommandChanged(CommandIDs.deleteCell);
     commands.notifyCommandChanged(CommandIDs.moveUp);
     commands.notifyCommandChanged(CommandIDs.moveDown);
   });
@@ -2834,12 +2911,17 @@ function addCommands(
   });
   commands.addCommand(CommandIDs.trust, {
     label: () => trans.__('Trust Notebook'),
-    execute: args => {
+    execute: async args => {
       const current = getCurrent(tracker, shell, args);
       if (current) {
         const { context, content } = current;
-        return NotebookActions.trust(content).then(() => context.save());
+        const trustResult = await NotebookActions.trust(content);
+        if (trustResult.trusted) {
+          await context.save();
+        }
+        return trustResult;
       }
+      return { trusted: false };
     },
     isEnabled,
     describedBy: {
@@ -3358,7 +3440,18 @@ function addCommands(
         return NotebookActions.deleteCells(current.content);
       }
     },
-    isEnabled: args => (args.toolbar ? true : isEnabled()),
+    isEnabled: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      if (!current) {
+        return false;
+      }
+      // The 'deletable' metadata is optional, null and undefined values should be made truthy
+      const deletable =
+        (current.content.activeCell?.model.getMetadata(
+          'deletable'
+        ) as unknown as boolean) !== false;
+      return deletable;
+    },
     describedBy: {
       args: {
         type: 'object',
@@ -3384,7 +3477,7 @@ function addCommands(
       const current = getCurrent(tracker, shell, args);
 
       if (current) {
-        return NotebookActions.splitCell(current.content);
+        return NotebookActions.splitCell(current.content, translator);
       }
     },
     isEnabled,
@@ -3404,7 +3497,12 @@ function addCommands(
         const addExtraLine =
           (settings?.get('addExtraLineOnCellMerge').composite as boolean) ??
           true;
-        return NotebookActions.mergeCells(current.content, false, addExtraLine);
+        return NotebookActions.mergeCells(
+          current.content,
+          false,
+          addExtraLine,
+          translator
+        );
       }
     },
     isEnabled,
@@ -3424,7 +3522,12 @@ function addCommands(
         const addExtraLine =
           (settings?.get('addExtraLineOnCellMerge').composite as boolean) ??
           true;
-        return NotebookActions.mergeCells(current.content, true, addExtraLine);
+        return NotebookActions.mergeCells(
+          current.content,
+          true,
+          addExtraLine,
+          translator
+        );
       }
     },
     isEnabled,
@@ -3444,7 +3547,12 @@ function addCommands(
         const addExtraLine =
           (settings?.get('addExtraLineOnCellMerge').composite as boolean) ??
           true;
-        return NotebookActions.mergeCells(current.content, false, addExtraLine);
+        return NotebookActions.mergeCells(
+          current.content,
+          false,
+          addExtraLine,
+          translator
+        );
       }
     },
     isEnabled,
@@ -4382,6 +4490,43 @@ function addCommands(
       }
     }
   });
+  commands.addCommand(CommandIDs.toggleOutputScrolling, {
+    label: args =>
+      args['isMenu'] || args['isPalette']
+        ? trans.__('Enable Scrolling for Outputs')
+        : trans.__('Toggle Scrolling for Outputs'),
+    execute: args => {
+      const current = getCurrent(tracker, shell, args);
+
+      if (current) {
+        if (isOutputScrollingEnabled(current.content)) {
+          return NotebookActions.disableOutputScrolling(current.content);
+        }
+
+        return NotebookActions.enableOutputScrolling(current.content);
+      }
+    },
+    isEnabled,
+    isToggled: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      if (current) {
+        return isOutputScrollingEnabled(current.content);
+      } else {
+        return false;
+      }
+    },
+    describedBy: {
+      args: {
+        type: 'object',
+        properties: {
+          isMenu: {
+            type: 'boolean',
+            description: trans.__('Whether the command is called from a menu')
+          }
+        }
+      }
+    }
+  });
   commands.addCommand(CommandIDs.selectLastRunCell, {
     label: trans.__('Select current running or last run cell'),
     execute: args => {
@@ -4925,13 +5070,16 @@ namespace Private {
     // If the container is not available, append the newly created container
     // to the current notebook panel and set related properties
     if (hiddenAlertContainer.getAttribute('id') !== hiddenAlertContainerId) {
-      hiddenAlertContainer.classList.add('sr-only');
       hiddenAlertContainer.setAttribute('id', hiddenAlertContainerId);
-      hiddenAlertContainer.setAttribute('role', 'alert');
-      hiddenAlertContainer.hidden = true;
       notebookNode.appendChild(hiddenAlertContainer);
     }
 
+    hiddenAlertContainer.classList.add('jp-sr-only');
+    hiddenAlertContainer.setAttribute('role', 'alert');
+    hiddenAlertContainer.setAttribute('aria-live', 'assertive');
+    hiddenAlertContainer.setAttribute('aria-atomic', 'true');
+    hiddenAlertContainer.hidden = false;
+
     // Insert/Update alert container with the notification message
     hiddenAlertContainer.innerText = message;
   }
@@ -4947,7 +5095,7 @@ namespace Private {
       this._index = options.index !== undefined ? options.index : -1;
       this._cell = options.cell || null;
       this.id = `LinkedOutputView-${UUID.uuid4()}`;
-      this.title.label = 'Output View';
+      this.title.label = trans.__('Output View');
       this.title.icon = notebookIcon;
       this.title.caption = this._notebook.title.label
         ? trans.__('For Notebook: %1', this._notebook.title.label)