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

package/lib/index.d.ts

@@ -7,6 +7,10 @@ import type { JupyterFrontEndPlugin } from '@jupyterlab/application';
  * A plugin providing a CommandEdit status item.
  */
 export declare const commandEditItem: JupyterFrontEndPlugin<void>;
+/**
+ * A plugin providing a current cell/total cells status item.
+ */
+export declare const cellCounterItem: JupyterFrontEndPlugin<void>;
 /**
  * A plugin that provides a execution indicator item to the status bar.
  */

package/lib/index.js

@@ -19,7 +19,7 @@ import { ILauncher } from '@jupyterlab/launcher';
 import { ILSPCodeExtractorsManager, ILSPDocumentConnectionManager, ILSPFeatureManager, IWidgetLSPAdapterTracker } from '@jupyterlab/lsp';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { IMetadataFormProvider } from '@jupyterlab/metadataform';
-import { CommandEditStatus, ExecutionIndicator, INotebookCellExecutor, INotebookTools, INotebookTracker, INotebookWidgetFactory, NotebookActions, NotebookAdapter, NotebookModelFactory, NotebookPanel, NotebookSearchProvider, NotebookToCFactory, NotebookTools, NotebookTracker, NotebookTrustStatus, NotebookWidgetFactory, setCellExecutor, StaticNotebook, ToolbarItems } from '@jupyterlab/notebook';
+import { CellCounterStatus, CommandEditStatus, ExecutionIndicator, INotebookCellExecutor, INotebookTools, INotebookTracker, INotebookWidgetFactory, NotebookActions, NotebookAdapter, NotebookModelFactory, NotebookPanel, NotebookSearchProvider, NotebookToCFactory, NotebookTools, NotebookTracker, NotebookTrustStatus, NotebookWidgetFactory, setCellExecutor, StaticNotebook, ToolbarItems } from '@jupyterlab/notebook';
 import { IPropertyInspectorProvider } from '@jupyterlab/property-inspector';
 import { IMarkdownParser, IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
@@ -125,6 +125,7 @@ var CommandIDs;
     CommandIDs.setSideBySideRatio = 'notebook:set-side-by-side-ratio';
     CommandIDs.enableOutputScrolling = 'notebook:enable-output-scrolling';
     CommandIDs.disableOutputScrolling = 'notebook:disable-output-scrolling';
+    CommandIDs.toggleOutputScrolling = 'notebook:toggle-output-scrolling';
     CommandIDs.selectLastRunCell = 'notebook:select-last-run-cell';
     CommandIDs.replaceSelection = 'notebook:replace-selection';
     CommandIDs.autoClosingBrackets = 'notebook:toggle-autoclosing-brackets';
@@ -185,11 +186,11 @@ const trackerPlugin = {
     autoStart: true
 };
 /**
- * The notebook cell factory provider.
+ * The notebook and cell factory provider.
  */
 const factory = {
     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,
@@ -248,6 +249,39 @@ export const commandEditItem = {
         });
     }
 };
+/**
+ * A plugin providing a current cell/total cells status item.
+ */
+export const cellCounterItem = {
+    id: '@jupyterlab/notebook-extension:cell-counter-status',
+    description: 'Adds a notebook cell counter status widget.',
+    autoStart: true,
+    requires: [INotebookTracker, ITranslator],
+    optional: [IStatusBar],
+    activate: (app, tracker, translator, statusBar) => {
+        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.
  */
@@ -422,7 +456,8 @@ export const exportPlugin = {
             // 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,
@@ -689,7 +724,8 @@ const updateRawMimetype = {
                 var _a;
                 const mimetypeExists = ((_a = properties.oneOf) === null || _a === void 0 ? void 0 : _a.filter(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;
                     properties.oneOf.push({
@@ -825,6 +861,7 @@ const plugins = [
     executionIndicator,
     exportPlugin,
     tools,
+    cellCounterItem,
     commandEditItem,
     notebookTrustItem,
     widgetFactoryPlugin,
@@ -1121,7 +1158,6 @@ function activateCodeConsole(app, tracker, translator) {
                 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 = await ((_b = (_a = current.context.sessionContext.session) === null || _a === void 0 ? void 0 : _a.kernel) === null || _b === void 0 ? void 0 : _b.requestIsComplete({
@@ -1425,6 +1461,7 @@ function activateNotebookHandler(app, factory, extensions, executor, palette, de
         var _a, _b, _c;
         // 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 === null || ft === void 0 ? void 0 : ft.icon;
         widget.title.iconClass = (_a = ft === null || ft === void 0 ? void 0 : ft.iconClass) !== null && _a !== void 0 ? _a : '';
@@ -1759,6 +1796,22 @@ function getCurrent(tracker, shell, args) {
     }
     return widget;
 }
+// Whether all selected code cells have output scrolling enabled.
+function isOutputScrollingEnabled(notebook) {
+    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.outputsScrolled) {
+                return false;
+            }
+        }
+    }
+    return hasCodeCell;
+}
 /**
  * Add the notebook commands to the application's command registry.
  */
@@ -1776,6 +1829,11 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
                 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 => {
@@ -1833,6 +1891,7 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
         commands.notifyCommandChanged(CommandIDs.runAndInsert);
     });
     tracker.activeCellChanged.connect(() => {
+        commands.notifyCommandChanged(CommandIDs.deleteCell);
         commands.notifyCommandChanged(CommandIDs.moveUp);
         commands.notifyCommandChanged(CommandIDs.moveDown);
     });
@@ -2077,12 +2136,17 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
     });
     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: {
@@ -2499,7 +2563,16 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
                 return NotebookActions.deleteCells(current.content);
             }
         },
-        isEnabled: args => (args.toolbar ? true : isEnabled()),
+        isEnabled: args => {
+            var _a;
+            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 = ((_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.model.getMetadata('deletable')) !== false;
+            return deletable;
+        },
         describedBy: {
             args: {
                 type: 'object',
@@ -2521,7 +2594,7 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
         execute: args => {
             const current = getCurrent(tracker, shell, args);
             if (current) {
-                return NotebookActions.splitCell(current.content);
+                return NotebookActions.splitCell(current.content, translator);
             }
         },
         isEnabled,
@@ -2539,7 +2612,7 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             const current = getCurrent(tracker, shell, args);
             if (current) {
                 const addExtraLine = (_a = settings === null || settings === void 0 ? void 0 : settings.get('addExtraLineOnCellMerge').composite) !== null && _a !== void 0 ? _a : true;
-                return NotebookActions.mergeCells(current.content, false, addExtraLine);
+                return NotebookActions.mergeCells(current.content, false, addExtraLine, translator);
             }
         },
         isEnabled,
@@ -2557,7 +2630,7 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             const current = getCurrent(tracker, shell, args);
             if (current) {
                 const addExtraLine = (_a = settings === null || settings === void 0 ? void 0 : settings.get('addExtraLineOnCellMerge').composite) !== null && _a !== void 0 ? _a : true;
-                return NotebookActions.mergeCells(current.content, true, addExtraLine);
+                return NotebookActions.mergeCells(current.content, true, addExtraLine, translator);
             }
         },
         isEnabled,
@@ -2575,7 +2648,7 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             const current = getCurrent(tracker, shell, args);
             if (current) {
                 const addExtraLine = (_a = settings === null || settings === void 0 ? void 0 : settings.get('addExtraLineOnCellMerge').composite) !== null && _a !== void 0 ? _a : true;
-                return NotebookActions.mergeCells(current.content, false, addExtraLine);
+                return NotebookActions.mergeCells(current.content, false, addExtraLine, translator);
             }
         },
         isEnabled,
@@ -3410,6 +3483,41 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             }
         }
     });
+    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 => {
@@ -3892,12 +4000,14 @@ var 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;
     }
@@ -3914,7 +4024,7 @@ var 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)