@jupyterlab/docmanager

@jupyterlab/docmanager

A JupyterLab package which handles interactions with documents and the file system. It opens and closes files, creates new views onto files, and keeps track of open documents.

The DocumentManager should be considered a singleton for the application.

Changelog

3.6.0

(Full Changelog)

New features added

• Add copy and paste commands to terminal context menu #13535 (@krassowski)
• Turn terminal links into anchors using xterm addon #13645 (@mgcth)
• Allows to pause the execution during debug #13494 (@brichet)
• Ask confirmation when closing a document #13489 (@fcollonval)
• Add events service #13465 (@fcollonval)
• Add notification queue and display using toast #12959 (@telamonian)
• Add announcements #13444 (@fcollonval)
• Add line history to Stdin cell outputs #13431 (@fcollonval)
• Add user configuration for additional schemes for the sanitizer plugin #13419 (@fcollonval)
• User service #12926 (@hbcarlos)

Enhancements made

• Expose contentVisibility widget hiding mode #13860 (@fcollonval)
• default locale will use OS default locale #13721 (@fcollonval)
• Enable strict CSS containment for MainAreaWidget #13811 (@krassowski)
• User defined default viewer take precedence for rendered factory #11541 (@fcollonval)
• Remove not needed Completer.IRenderer.sanitizer #13700 (@fcollonval)
• Contain the tabs within the tabbar (do not use translation transform) #13671 (@krassowski)
• Sanitize notification message #13510 (@fcollonval)
• Use more the contextual collaborative model attribute #13564 (@fcollonval)
• Add lumino with support for plugin deactivation #13541 (@fcollonval)
• Sets whether the model is collaborative or not when registering its factory #13526 (@hbcarlos)
• RTC: Move user name to user panel #13517 (@martinRenou)
• jupyter_server_ydoc>=0.6.0,<0.7.0 #13499 (@fcollonval)
• Define file or activity icons color as static #13408 (@fcollonval)
• Added collaborative_document_save_de… #13404 (@fcollonval)
• Add a hover effect to plugin list entries #13384 (@krassowski)
• Bump Lumino 1.x #13378 (@fcollonval)
• Store original path as returned from contents API in the Contents.IModel #13216 (@krassowski)
• Update document dirty logic for RTC #13364 (@davidbrochart)
• Store document info in the state not in a separate context map out of the document interface. #13317 (@fcollonval)
• Use file ID #13246 (@davidbrochart)
• Relax doc provider API #13214 (@fcollonval)
• Avoids restoring widget in dock panel when first loading in 'single-document' mode #13314 (@brichet)
• Fix illegible white on yellow text of stacktrace in dark theme #13249 (@NikolayXHD)
• Use settings icons for 6 plugins #13298 (@krassowski)
• Do not run galata in .ipynb_checkpoints #13297 (@krassowski)
• Allow empty notebook #13296 (@martinRenou)
• Optimize text mimerenderer: ansi vs autolink #13202 (@vidartf)
• Remove Yjs locking mechanism #13222 (@davidbrochart)

Bugs fixed

• Define colour and background for filebrowser edit field #13895 (@krassowski)
• Reset execution indicator state when kernel restarts #13832 (@krassowski)
• Restore blueprint focus overrides on 3.x branch #13879 (@krassowski)
• Restore partial border effect for menu #13878 (@krassowski)
• Pin jupyter_ydoc #13863 (@fcollonval)
• Fix preferred_dir for examples #13788 (@fcollonval)
• Bump canvas to version with nodejs 18 binaries #13783 (@fcollonval)
• Explain why cell model may be missing in cell toolbar #13763 (@krassowski)
• Fix handling of settingEditorType #13761 (@jtpio)
• Fix execution indicator in RTC mode #13693 (@trungleduc)
• Force jupyter-server v1 to check against notebook v6 #13716 (@fcollonval)
• Write the browser open files for test #13634 (@fcollonval)
• Add the scaleFactor value from the embed options when creating the PNG representation for a Vega-based chart #13610 (@joaopalmeiro)
• Does not prevent default behavior when shift-clicking #13616 (@jmk89)
• Do not load CSS of disabled federated extensions #11962 (@jtpio)
• use jupyter_config_dir instead of config_path[0] for workspaces, settings #13589 (@minrk)
• Bump @lumino/application #13590 (@fcollonval)
• Restores the appearance of the settingeditor's input focus #13554 (@brichet)
• Fix a wrong argument when calling 'renderMimeVariable' #13531 (@brichet)
• fix size of toc running indicator #13568 (@uenot)
• Fixes backward-incompatible changes for 3.6 #13560 (@hbcarlos)
• Make focus visible (mostly CSS) #13415 (@gabalafou)
• Set corrections to icons and switch colors #13500 (@HaudinFlorence)
• Default IDocumentProviderFactory.IOptions generic to ISharedDocument #13490 (@jtpio)
• Use same key for saving user info in local store #13482 (@hbcarlos)
• Set fallback values for icons colors. #13468 (@HaudinFlorence)
• Backport #13458 on branch 3.6.x (Enable document model specific collaboration) #13480 (@fcollonval)
• Share attachments #13450 (@hbcarlos)
• Fix key name for nbformat minor version #13377 (@fcollonval)
• Remove metadata entries #13371 (@hbcarlos)
• Updates JSONEditor's source only when there is an active cell or an active notebook panel #13308 (@hbcarlos)
• Avoids use of @deprecated to refer to a parameter #13309 (@JasonWeill)
• Fix border-radius does not follow css variable #13289 (@vthinkxie)
• Set isUntitled to false on document path changes #13268 (@fcollonval)
• Remove some unused CSS styles and fix icon alignment in plugin list #13255 (@krassowski)
• Fix notebook trust in RTC #13274 (@davidbrochart)
• Don't dispose the notebook metadata editor on active cell change #13259 (@fcollonval)

Maintenance and upkeep improvements

• Bump @lumino/widgets to 1.37.1 on 3.6 branch #13829 (@krassowski)
• Clean examples #13812 (@fcollonval)
• Added config to link ts source maps #13765 (@3coins)
• Fix preferred_dir for examples #13788 (@fcollonval)
• Bump canvas to version with nodejs 18 binaries #13783 (@fcollonval)
• Drop the dependency on @jupyterlab/buildutils in @jupyterlab/builder #13741 (@jtpio)
• Remove empty button in the notebook toolbar #13691 (@trungleduc)
• Pin check release action without pyproject validation #13714 (@fcollonval)
• Update copyright date to 2023 in the about dialog #13708 (@jtpio)
• Fix links in CHANGELOG.md #13698 (@jtpio)
• Write the browser open files for test #13634 (@fcollonval)
• Bump sanitize-html to 2.7.3 #13509 (@fcollonval)
• Depend on @jupyter/ydoc instead of @jupyter-notebook/ydoc #13506 (@jtpio)
• Fix Python test dependencies #13508 (@fcollonval)
• Require jupyter-server-ydoc >=0.5.1 #13479 (@fcollonval)
• Require jupyter_server_ydoc >=0.4.0 #13437 (@hbcarlos)
• Use more consistent naming for user service #13435 (@fcollonval)
• Deprecate managing source extensions with jupyter labextension #13424 (@jtpio)
• Bump jupyter_server_ydoc #13407 (@fcollonval)
• tomllib is in stdlib in Python 3.11+ #13405 (@fcollonval)
• Extract @jupyterlab/shared-models to @jupyter/ydoc #13398 (@fcollonval)
• Integrity check does not clean style import when emptied #13367 (@fcollonval)
• Fix the examples with jupyter-server v2 #13336 (@fcollonval)
• Check a core path is actually a package #13346 (@fcollonval)
• Removes empty requires list #13334 (@hbcarlos)
• Fix Binder for jupyter-server v2 #13344 (@fcollonval)
• Switch to releaser v2 #13322 (@blink1073)
• Fix memory leaks #13229 (@fcollonval)
• Update branch configuration #13220 (@fcollonval)

Documentation improvements

• Force jupyter-server v1 to check against notebook v6 #13716 (@fcollonval)
• Fix links in CHANGELOG.md #13698 (@jtpio)
• Do not load CSS of disabled federated extensions #11962 (@jtpio)
• Copy edit for privacy policy docs #13594 (@JasonWeill)
• Bug fixes/revisions for the Lab extension tutorial #13593 (@ericsnekbytes)
• Documentation RTC and user service (#13578) #13591 (@hbcarlos)
• Forbid using RTC mode without Jupyter Server v2. #13472 (@fcollonval)
• Remove broken URL #13445 (@fcollonval)
• Move configuration to jupyter-server-ydoc #13425 (@fcollonval)
• Update the tutorial to reflect the changes in the latest cookiecutter… #13417 (@frivas-at-navteca)
• Fix Binder for jupyter-server v2 #13344 (@fcollonval)
• Correct starting docs: working directory path sample code #13261 (@hugetim)
• Backporting IUser/Collaboration PRs #13242 (@martinRenou)
• Update example documentation: lab -> app #13223 (@davidbrochart)
• Remove Yjs locking mechanism #13222 (@davidbrochart)
• Update branch configuration #13220 (@fcollonval)
• Update README.md #13257 (@liliyao2022)

API and Breaking Changes

• Enable document model specific collaboration #13480 (@fcollonval)
• Improve document dirty logic for RTC #13364 (@davidbrochart)
• Store document info in the state not in a separate context map out of the document interface. #13317 (@fcollonval)
• Remove Yjs locking mechanism #13222 (@davidbrochart)
• Move configuration to jupyter-server-ydoc #13425 (@fcollonval)
• Extract @jupyterlab/shared-models to @jupyter/ydoc #13398 (@fcollonval)

Contributors to this release

(GitHub contributors page for this release)

@afshin | @andrii-i | @blink1073 | @bollwyvl | @brichet | @Carreau | @davidbrochart | @echarles | @ellisonbg | @ericsnekbytes | @fcollonval | @fperez | @github-actions | @HaudinFlorence | @hbcarlos | @jasongrout | @JasonWeill | @jtpio | @jupyterlab-dev-mode | @jupyterlab-probot | @krassowski | @martinRenou | @meeseeksdev | @meeseeksmachine | @psychemedia | @SylvainCorlay | @trungleduc | @uenot | @vidartf | @welcome

v3.5