# jupyterlab-browser-storage > A JupyterLab Drive to save files in the browser storage Latest version **0.1.1** (published 2026-02-28) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install jupyterlab-browser-storage pnpm add jupyterlab-browser-storage yarn add jupyterlab-browser-storage bun add jupyterlab-browser-storage ``` ## Health **Score 55/100 (C)** — status: stable. Positive: has types; no vulnerabilities; has provenance. Warnings: low downloads; no esm support; pre 1.0. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2026-02-28 | | First published | 2024-03-07 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 14 | | Unpacked size | 74.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | Author | JupyterLab Contrib Team | | Maintainers | parente, lckr, fcollonval, vidartf, krassowski, jtpio, zacharyrs, jupyterlab-contrib-bot, yuvipanda, martinrenou, brichet, beenje, rmarieta, ryantam626, stellarshenson | | Keywords | jupyter, jupyterlab, jupyterlab-extension | ## Links - npm: https://www.npmjs.com/package/jupyterlab-browser-storage - Repository: https://github.com/jupyterlab-contrib/jupyterlab-browser-storage - Issues: https://github.com/jupyterlab-contrib/jupyterlab-browser-storage/issues - npm.io page: https://npm.io/package/jupyterlab-browser-storage ## Dependencies (14) - [mime](https://npm.io/package/mime.md) ^3 - [localforage](https://npm.io/package/localforage.md) ^1.9.0 - [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^2.1.2 - [@lumino/signaling](https://npm.io/package/@lumino/signaling.md) ^2.1.2 - [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^4.0.0 - [@jupyterlab/nbformat](https://npm.io/package/@jupyterlab/nbformat.md) ^4.0.0 - [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^7.0.0 - [@jupyterlab/coreutils](https://npm.io/package/@jupyterlab/coreutils.md) ^6.0.0 - [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^4.0.0 - [@jupyterlab/filebrowser](https://npm.io/package/@jupyterlab/filebrowser.md) ^4.0.0 - [@jupyterlab/translation](https://npm.io/package/@jupyterlab/translation.md) ^4.0.0 - [@jupyterlab/ui-components](https://npm.io/package/@jupyterlab/ui-components.md) ^4.0.0 - [@jupyterlab/settingregistry](https://npm.io/package/@jupyterlab/settingregistry.md) ^4.0.0 - [@jupyterlab/rendermime-interfaces](https://npm.io/package/@jupyterlab/rendermime-interfaces.md) ^3.9.0 ## Recent versions - 0.1.1 (latest) — 2026-02-28 - 0.1.0 — 2024-03-07 ## README # jupyterlab-browser-storage [![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-browser-storage/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-browser-storage/actions/workflows/build.yml) A JupyterLab Drive to save files in the browser storage. > [!WARNING] > This is still a work-in-progress and some functionalities are not yet working as expected. ## Context This extension originates from the JupyterLite contents manager. ## Requirements - JupyterLab >= 4.0.0 ## Install To install the extension, execute: ```bash pip install jupyterlab_browser_storage ``` ## Programmatic Usage The package can also be used as a library when only the drive implementation is needed: ```ts import { BrowserStorageDrive } from 'jupyterlab-browser-storage'; import localforage from 'localforage'; const drive = new BrowserStorageDrive({ localforage }); ``` The root package export (`jupyterlab-browser-storage`) still provides the JupyterLab plugin as the default export. ## Uninstall To remove the extension, execute: ```bash pip uninstall jupyterlab_browser_storage ``` ## Contributing ### Development install Note: You will need NodeJS to build the extension package. The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use `yarn` or `npm` in lieu of `jlpm` below. ```bash # Clone the repo to your local environment # Change directory to the jupyterlab_browser_storage directory # Install package in development mode pip install -e "." # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite # Rebuild extension Typescript source after making changes jlpm build ``` You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. ```bash # Watch the source directory in one terminal, automatically rebuilding when needed jlpm watch # Run JupyterLab in another terminal jupyter lab ``` With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt). By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command: ```bash jupyter lab build --minimize=False ``` ### Development uninstall ```bash pip uninstall jupyterlab_browser_storage ``` In development mode, you will also need to remove the symlink created by `jupyter labextension develop` command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions` folder is located. Then you can remove the symlink named `jupyterlab-browser-storage` within that folder. ### Testing the extension #### Integration tests This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests). More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab. More information are provided within the [ui-tests](./ui-tests/README.md) README. ### Packaging the extension See [RELEASE](RELEASE.md) --- _Source: https://npm.io/package/jupyterlab-browser-storage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._