@jupyterlab/rendermime-interfaces

@jupyterlab/rendermime-interfaces

A package for JupyterLab which provides interfaces for implementing mime renderer extensions.

A general JupyterLab plugin involves a certain amount of boilerplate code that can be annoying for authors of relatively extensions. The interfaces in this package are meant to give an easier way for extension authors to provide a plugin that renders mime bundles and documents of a specific mime type.

When using these interfaces, extensions only need to provide some metadata about wht kind of mime bundle they are able to render, and a Widget with a renderModel method that renders the mime bundle.

Examples can be found in @jupyterlab/vega2-extension and @jupyterlab/pdf-extension.

Changelog

v1.0.0

June 28, 2019

See the JupyterLab 1.0.0 milestone on GitHub for the full list of pull requests and issues closed in 1.0.0, and other 1.0.x milestones for bugs fixed in patch releases.

Find and Replace

<img alt="A notebook with multiple cells and the find and replace interface in the upper right." src="https://raw.githubusercontent.com/jupyterlab/jupyterlab/3.1.x/docs/source/getting_started/find.png" class="jp-screenshot">

We have added first class support for find and replace across JupyterLab. It is currently supported in notebooks and text files and is extensible for other widgets who wish to support it. (#6350, #6322, #6301, #6282, #6256, #6241, #6237, #6159, #6081, #6155, #6094, #6024, #5937, #5795, #1074)

Status Bar

<img alt="A screenshot of the updated JupyterLab status bar." src="https://raw.githubusercontent.com/jupyterlab/jupyterlab/3.1.x/docs/source/getting_started/statusbar.png" class="jp-screenshot">

We have integrated the JupyterLab Status Bar package package into the core distribution. Extensions can add their own status to it as well (#5577, #5525 #5990, #5982, #5514, #5508, #5352).

JupyterHub Integration

• We now include the JupyterHub extension in core JupyterLab, so you no longer need to install @jupyterlab/hub-extension. (#6451, #6428)
• JupyterLab now has a File > Logout menu entry when running with JupyterHub (#6087, #5966)

Printing

We now have a printing system that allows extensions to customize how documents and activities are printed. (#5850, #1314)

Other User Facing Changes

• The launcher displays longer kernel names and supports keyboard navigation (#6587)
• Notebook outputs without any valid MimeType renderers will not be displayed, instead of displaying an error (#6559, #6216)
• Add tooltip to file browser root breadcrumb icon showing the server root, if it is available (#6552)
• Downloading a file will no longer open a new browser window (#6546)
• Rename the help "Inspector" to "Contextual Help" and move it to the "Help" menu (#6493, #6488, #6678, #6671)
• Update many of the icons to make them more consistent (#6672, #6618, #6664, #6621)
• Update the settings UI to remove the table view (#6654, #6622, #6653, #6623, #6646, #6642)
• Replace FAQ Extension with link to JupyterLab documentation (#6628, #6608, #6625, #6610)
• Change the default keyboard shortcut for closing a tab to be Alt+w instead of Cmd/Ctrl+w to avoid conflicts with operating systems. (#6486, #6357)
• Show help text in Inspector window to describe you should select a function (#6476)
• Fixes SVG rendering (#6469, #6295)
• Add support for dropping a tab in the tab bar area. (#6454, #5406)
• Switch some default shortcuts to use Accel instead of Ctrl so they are more natural for Mac users (#6447, #5023)
• Add ability to tell between hover and selected command palette items (#6407, #279)
• Hide the "Last Modified" column when the file browser is narrow (#6406, #6093)
• Support copy/paste in terminal and Mac OS using Ctrl+C and Ctrl+V (#6391, #6385, #1146)
• Support scrolling in running kernels panel (#6383, #6371)
• Adds ability to "Merge Selected Cells" in the context menu in the notebook (#6375, #6318)
• Turn On Accessibility In Xterm.js to make it more compatible for screen readers (#6359)
• When selecting cells using the keyboard shortcuts, we now skip collapsed cells (#6356, #3233)
• Supporting opening .geojson files in JSON viewer (#6349)
• Performance fixes for text-based progress bars (#6304, #4202)
• Add support for rendering Vega 5 and Vega Lite 3 while keeping the existing Vega 4 and Vega Lite 2 renderers (#6294, #6133, #6128, #6689, #6685, #6684, #6675, #6591, #6572)
• Drag and drop console cells into a notebook or text editor (#5585, #4847)
• Drag and drop notebook cells into a console or text editor (#5571, #3732)
• The extension manager search now sorts extensions by the score assigned to them by NPM instead of alphabetically (#5649)
• Notify the user when a kernel is automatically restarted, for example, if crashes from an out of memory error (#6246, #4273)
• Expose the extension manager in a command and menu item (#6200)
• Add command to render all Markdown cells (#6029, #6017)
• Supports using shift to select text in output area (#6015, #4800)
• Output areas that opened in new views are restored properly now on reload (#5981, #5976)
• Add support for managing notebook metadata under a new "Advanced Tools" section in the cell tools area. The cell and notebook metadata now always reflect the current state of the notebook (#5968, #5200)
• Inherit terminal theme from core theme (#5964)
• Adds a built-in HTML viewer so that you can view HTML files (#5962, #5855, #2369)
• New workspaces are now automatically generated when you create a new window with the same workspace name. (#5950, #5854, #5830, #5214)
• We now add a hint to the context menu to describe how you can access the native browser menu (#5940, #4023)
• The tabs on the left panel have changed to make them more understandable (#5920, #5269)
• Start a new terminal when the page is refreshed and the old terminal has died (#5917)
• Add a command to open the main menus, which can be assigned to a keyboard shortcut to open and navigate menus without a mouse (#5910, #3074)
• The contextual help now updates based on changes in the cursor from the mouse instead of just from the keyboard (#5906, #5899)
• The launcher now updates when the kernels change on the server (#5904, #5676)
• Retain cell auto scroll behavior even when a cell output is cleared (#5817, #4028)
• If you link to a relative path that is not a file in a markdown cell, this will now be preserved instead of changing it to a file URL (#5814)
• Adds the ability to link to a certain row in a CSV file and have the viewer open to that row (#5727, #5720)
• We have improved the performance of switching to a large notebook (#5700, #4292, #2639)
• The vdom extension now supports event handling, so that you can have kernel code run in response to user interaction with the UI (#5670)
• Adds the ability to run "Run All Code" and "Restart Kernel and Run All Code" in code and markdown files (#5641, #5579)
• We now remember what line ending a text file has when loading it, so that files with CRLF line endings will properly be saved with the same endings (#5622, #4464, #3901, #3706)
• Fixes rendering of SVG elements in HTML MimeType output (#5610, #5610, #5589)
• Allow copying files by holding down Ctrl when dragging them in the file browser (#5584, #3235)
• Switch the hover modified time in the file browser to use the local format (#5567)
• We have added a default keyboard shortcut of Ctrl Shift Q for closing and cleaning up a file (#5534, #4390)
• Adds the ability to find and go to a certain line in the CSV viewer (#5523)
• Add the ability to create new text and markdown files from the launcher and command palette (#5512, #5511)
• A "New Folder" option has been added to the file browser context menu (#5447)
• The ANSI colors are now the same as those in the classic notebook (#5336, #3773)
• Send complete statements instead of current lines when stepping through code in a cell (#6515, #6063)
• Description list styles (dl, dt, dd) are improved to be consistent with the nteract project (#5682, #2399)

Settings

• The settings system has been rewritten (#5470, #5298) and now uses json5 as the syntax, which supports comments and other features for better human readability (#6343, #6199).
• The keyboard shortcut system has been rewritten and now displays a list of system commands in the settings comments (#5812, #5562).

There are new settings for many following items, including:

• Adds an option to shut down terminals and notebook kernels when they are closed (#6285, #6275)
• Scrolling past the end of a notebooks and text editor document (#5542, #5271, #5652, #4429)
• Text editor code folding, rulers, and active line highlighting (#5761, #4083, #5750, #4179, #5529, #5528)
• Markdown viewer options (#5901, #3940)
• Terminal scrollback and other settings (#5609, #3985)
• The autosave interval (#5645, #5619)
• The file browser showing the current active file (#5698, #4258)
• Custom scrollbar styling for dark themes (#6026, #4867)

Command Line Changes

• Installing extensions will be quieter and adds a --debug to extension installing (#6567, #6499, #5986)
• We now support running JupyterLab when its application directory is a symlink (#6240, #6166)
• Add --all flag to labextension uninstall to remove all extensions (#6058, #6006)
• Adds the ability to override the base URLs from the config (#5518, #5503)
• Updates to workspaces CLI command (#6473, #5977, #6276, #6234, #6210, #5975, #5695, #5694)

Extension Development Changes

• We have rewritten how extensions provide keyboard shortcuts and interact with the settings system. If you previously defined keyboard shortcuts or used the settings mechanism, you will need to update your extension (#5470, #5298)
• We have renamed the plugin type from JupyterLabPlugin to JupyterFrontEndPlugin. The application arg is also renamed from JupyterLab to JupyterFrontEnd and some its functionality has been moved to a separate ILabShell plugin (#5845, #5919)
• The lab shell addToMainArea, addToLeftArea, addToTopArea, addToRightArea, and addToBottomArea functions have been replaced with a single add() function that takes the area as an argument. Replace addToMainArea(widget, options) with add(widget, 'main', options), etc. (#5845)
• Rename pageUrl to appUrl in the server connection (#6509, #6508, #6585, #6584)
• MainAreaWidget instances now forward update requests to their content (#6586, #6571)
• The theme data attributes are renamed and moved to the document body element. If you are relying on these attributes in CSS to conditionally style based on the theme, you should update their names. For example data-theme-light is now data-jp-theme-light. (#6566, #6554)
• Extensions which require CSS should no longer import their CSS files into their Javascript files. Instead, they should specify a root CSS file in the style attribute in their package.json, and JupyterLab will automatically import that CSS file. (#6533, #6530, #6395, #6390)
• Dialog.prompt has been replaced by a number of type-specific dialogs such as InputDialog.getString, InputDialog.getBoolean, etc. (#6522, #6378, #6327, #6326)
• When a RenderMime widget is re-rendered, the default behavior is to remove any existing content in the DOM. This can be overridden if needed. (#6513, #6505, #6497)
• We have updated our internal TypeScript version to 3.5.1 and our compile target to ES2017. Extensions may need to upgrade their TypeScript version and target as well. (#6440, #6224)
• We have updated the typings for some of the Kernel messages so that they better match the spec. (#6433)
• A connectionFailure signal has been added to some of the manager classes, which can be used to detect when a connection to the server is lost (#6399, #6176, #3324)
• Add rate limiting and polling utilities to coreutils to use for throttling and debouncing of API requests (#6345, #6346, #6401, #6305, #6157, #6192, #6186, #6141, #3929, #6141, #3929, #6186, #6192, #6401 ,#6305, #6157)
• Require session when instantiating terminal widget (#6339, #5061)
• Provides a signal to see what items are opened in a directory listing (#6270, #6269)
• Ads the ability to add widget above the main work area to a top header area (#5936)
• Renames contextMenuFirst to contextMenuHitTest in the JupyterFrontEnd (#5932)
• Removes the initialCommand arg from the terminal creation command. (#5916)
• Adds --jp-code-cursor-width0, --jp-code-cursor-width1, and --jp-code-cursor-width2 variables to the themes to support changing the cursor width if you change the font size (#5898)
• Adds the ability to insert a new item to the toolbar before or after another item (#5896, #5894)
• Adds the ability for extensions to register new CodeMirror modes (#5829)
• We have removed the JUPYTERLAB_xxx_LOADER Webpack loaders, instead you should use the loader directly in the URL as Webpack supports it (#5709, #4406)
• Adds the ability to handle fragments for document widgets (#5630, #5599)
• We have added a @jupyterlab/ui-components package that contains reusable React components to be used internally and in extensions. Feel free to use this to create extension UIs with consistent styles (#5538)
• The showErrorMessage function now lets you customize the buttons it uses (#5513)
• We now provide helpers for using React components within JupyterLab. If you were previously using ReactElementWidget you should switch to using ReactWidget. (#5479, #5766, #6595, #6595)
• The share link command has been moved to its own extension so that it can be overridden (#5460, #5388)
• Creating a new services session now requires passing a kernel model instead of a kernel instance (#6503, #6142)
• We upgraded the Webpack raw file loader. The new version of the raw loader exports ES2015 modules, so this may require changes in extensions that import files using the raw loader. For example, if you did require('myfile.md') to get the content of myfile.md as a string, you now should import it using ES2015 import syntax, or use require(\'myfile.md\').default.
• Widget factories now can support custom cloning behavior from an optional source widget (#6060, #6044)
• We have renamed the type InstanceTracker to WidgetTracker (#6569).
• In order to add widgets to the main area (e.g. as in the old XKCD extension tutorial), the correct syntax is now app.shell.add(widget) or app.shell.add(widget, 'main'), see here.