jupyterlab-widgets
Jupyter interactive widgets for JupyterLab
Description
# Jupyter Widgets JupyterLab Extension A JupyterLab extension for Jupyter/IPython widgets. ## Installation To enable ipywidgets support in JupyterLab 3.x or 4.x: ```bash pip install jupyterlab_widgets ``` ### Version compatibility Prior to JupyterLab 3.0, use the appropriate command from the following list to install a compatible JupyterLab extension. - For JupyterLab 0.30, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.31` - For JupyterLab 0.31rc1, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.32` - For JupyterLab 0.31rc2, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.33` - For JupyterLab 0.31.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.34` - For JupyterLab 0.32.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.35` - For JupyterLab 0.33.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.36` - For JupyterLab 0.34.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.37` - For JupyterLab 0.35.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.38` - For JupyterLab 1.0.x and 1.1.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.0` - For JupyterLab 1.2.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1` - For JupyterLab 2.x, use `jupyter labextension install @jupyter-widgets/jupyterlab-manager@2` ## Contributing ### Development install Note: You will need Node.js 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_widgets 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). ### Uninstall ```bash pip uninstall jupyterlab_widgets ```
Release History
| Version | Changes | Urgency | Date |
|---|---|---|---|
| 3.0.16 | Imported from PyPI (3.0.16) | Low | 4/21/2026 |
| 8.1.8 | ## What's Changed * Add JupyterCon banner and jupyter colors by @choldgraf in https://github.com/jupyter-widgets/ipywidgets/pull/3998 * Fix badge formatting in README.md by @Carreau in https://github.com/jupyter-widgets/ipywidgets/pull/4000 * Add Plausible web stats by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/4003 * Update jupyterlab_widgets metadata to indicate it works with JupyterLab 4 by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/4004 ## | Low | 11/1/2025 |
| 8.1.7 | ## What's Changed * Fix CI + remove Python 3.8 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3989 * Dynamic widgets registry by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3988 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/8.1.6...8.1.7 | Low | 5/5/2025 |
| 8.1.6 | ## What's Changed * Fix lumino and lab packages pinning by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3958 * Typo fix by @david4096 in https://github.com/jupyter-widgets/ipywidgets/pull/3960 * Update lables even without MatJax/TypeSetter by @DonJayamanne in https://github.com/jupyter-widgets/ipywidgets/pull/3962 * Update github actions and fix readthedocs by @brichet in https://github.com/jupyter-widgets/ipywidgets/pull/3983 * Fix the new line when pressing enter in | Low | 4/11/2025 |
| 7.8.5 | ## What's Changed * 7.x: Allow building against JupyterLab 4 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3955 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/7.8.4...7.8.5 | Low | 10/22/2024 |
| 7.8.4 | ## What's Changed * 7.x: Fix widget state saving logic for JupyterLab 4 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3943 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/7.8.3...7.8.4 | Low | 9/3/2024 |
| 8.1.5 | ## What's Changed * More Phosphor backward compatibility by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3942 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/8.1.4...8.1.5 | Low | 8/22/2024 |
| 8.1.4 | ## What's Changed ### New features * Allow `interact` to use basic type hint annotations by @corranwebster in https://github.com/jupyter-widgets/ipywidgets/pull/3908 * Support horizontal orientation of radio buttons by @DonJayamanne in https://github.com/jupyter-widgets/ipywidgets/pull/3620 ### Maintenance and bug fixes * Fix compatibility with pytest 8 by @frenzymadness in https://github.com/jupyter-widgets/ipywidgets/pull/3903 * HTMLManager: Support both ipywidgets 7 and 8 models | Low | 8/22/2024 |
| 7.8.3 | ## What's Changed * 7.x: Fix Tabs and Accordions CSS when using lab 4 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3931 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/7.8.2...7.8.3 | Low | 7/29/2024 |
| 7.8.2 | ## What's Changed * Fix ipywidgets 7 in JupyterLab 4 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3927 **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/7.8.1...7.8.2 | Low | 7/29/2024 |
| 8.1.3 | ## Bug fixes * Add support for widgets in JupyterLab code consoles by @jtpio in https://github.com/jupyter-widgets/ipywidgets/pull/3004 * Add return to pack_models by @gjmooney in https://github.com/jupyter-widgets/ipywidgets/pull/3923 ## Documentation * Docs: Update jupyterlite by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3918 * Docs: Fix jupyterlite deployment by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3919 ## New Contributors * @g | Low | 5/28/2024 |
| 8.1.2 | ## What's Changed * Bump systeminformation from 5.18.3 to 5.21.8 in /ui-tests by @dependabot in https://github.com/jupyter-widgets/ipywidgets/pull/3837 * Try to use manager's latexTypesetter if window.MathJax is not defined by @bollwyvl in https://github.com/jupyter-widgets/ipywidgets/pull/3847 * fix: restoring widgets from saved state is broken since v8 in Lab by @mariobuikhuizen in https://github.com/jupyter-widgets/ipywidgets/pull/3866 **Full Changelog**: https://github.com/jupyter- | Low | 2/22/2024 |
| 8.1.1 | ## What's Changed ### Bug fixed * Raise error when __copy__ method is used on base widget class by @mmc1718 in https://github.com/jupyter-widgets/ipywidgets/pull/3780 * Reverts #3689 and #3738 back to the original working codebase by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3830 ### Docs * Update to JupyterLite 0.1.0 by @jtpio in https://github.com/jupyter-widgets/ipywidgets/pull/3820 ## New Contributors * @mmc1718 made their first contribution in https | Low | 9/13/2023 |
| 8.1.0 | ## Improvements * Allow CSS variables to be used as values in the Color trait by @nurbo in https://github.com/jupyter-widgets/ipywidgets/pull/3796 * Replace ipykernel dependency by the comm dependency by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3811 ### Documentation * Fix link to "Output widget examples" by @warrickball in https://github.com/jupyter-widgets/ipywidgets/pull/3801 * docs: remove developer docs resources by @emmanuel-ferdman in https://github.co | Low | 8/1/2023 |
| 8.0.7 | ## What's Changed * fixed typo in docs by @djp52 in https://github.com/jupyter-widgets/ipywidgets/pull/3714 * DOC: added instruction to "Installing with pip" section by @StefanieSenger in https://github.com/jupyter-widgets/ipywidgets/pull/3779 * Lint by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/3782 * Fix tab widget with JupyterLab 4 by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3787 * Explain that ipywidgets is part of jupyter-widgets softwar | Low | 7/4/2023 |
| 8.0.6 | ## What's Changed * BUG: comm.kernel should be None when it has no kernel by @pllim in https://github.com/jupyter-widgets/ipywidgets/pull/3732 * Run prettier by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3734 * add comm_manager check by @TTianshun in https://github.com/jupyter-widgets/ipywidgets/pull/3740 * Fix kernel attribute check by @martinRenou in https://github.com/jupyter-widgets/ipywidgets/pull/3737 * Add default `pack_models` by @bollwyvl in https://github.c | Low | 7/4/2023 |
| 8.0.5 | ## What's Changed * Fix deprecation warning by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/3670 * Overhaul docs toolchain by @bollwyvl in https://github.com/jupyter-widgets/ipywidgets/pull/3673 * More docs updates by @bollwyvl in https://github.com/jupyter-widgets/ipywidgets/pull/3674 * guard assignment of `Element.prototype` by @stevejpurves in https://github.com/jupyter-widgets/ipywidgets/pull/3644 * Add html colors "grey" in addition to "gray" by @Aztah in https://g | Low | 3/22/2023 |
| 8.0.4 | ## What's Changed * Fix slider change event issue with tapping by @ibdafna in https://github.com/jupyter-widgets/ipywidgets/pull/3617 * Fix unintentional deprecation warnings by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/3650 * define `process.env` for jlab dependencies by @stevejpurves in https://github.com/jupyter-widgets/ipywidgets/pull/3643 * Fix registry state lookup by @bollwyvl in https://github.com/jupyter-widgets/ipywidgets/pull/3653 **Full Changelog**: h | Low | 3/22/2023 |
| 8.0.3 | ## What's Changed * fix: make .widget and .widget_types deprecated by @maartenbreddels in https://github.com/jupyter-widgets/ipywidgets/pull/3567 * Button tooltip fix - default to description by @jmk89 in https://github.com/jupyter-widgets/ipywidgets/pull/3589 * Backport PR #3590: using _comm_default shadows possible bugs by @maartenbreddels in https://github.com/jupyter-widgets/ipywidgets/pull/3591 * Add dev meeting info to readme by @jasongrout in https://github.com/jupyter-widgets/ipywidg | Low | 3/22/2023 |
| 8.0.2 | ## What's Changed * Update to lerna 5.4.3 by @jtpio in https://github.com/jupyter-widgets/ipywidgets/pull/3548 * Deserialize state before setting it, as is done elsewhere set_state is used by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/3549 * Make the selection widgets mapping options error more helpful. by @jasongrout in https://github.com/jupyter-widgets/ipywidgets/pull/3556 * Allow the 'class' attribute to pass the sanitizer by @jasongrout in https://github.com/jupyt | Low | 3/22/2023 |
| 8.0.1 | **Full Changelog**: https://github.com/jupyter-widgets/ipywidgets/compare/8.0.0...8.0.1 | Low | 3/22/2023 |
| 8.0.0 | ## What's Changed See the [8.0.0 changelog](https://ipywidgets.readthedocs.io/en/8.0.0/changelog.html) for a more comprehensive summary of changes. To see the full list of pull requests and issues, see the [8.0 milestone](https://github.com/jupyter-widgets/ipywidgets/milestone/30?closed=1) on GitHub, or the [full list of changes since 7.x](https://github.com/jupyter-widgets/ipywidgets/compare/7.x...8.0.0). ### Users Here are some highlights of user-visible changes in ipywidgets 8.0. | Low | 8/18/2022 |
| 7.7.1 | 7.7.1 ----- To see the full list of pull requests, see the [7.7.1 milestone](https://github.com/jupyter-widgets/ipywidgets/milestone/36?closed=1) on GitHub. Highlights include: - Fix broken link icon for FontAwesome 4 and 5 [#3495](https://github.com/jupyter-widgets/ipywidgets/pull/3495) - Fix message throttling bug [#3494](https://github.com/jupyter-widgets/ipywidgets/pull/3494) - Fix state message parsing to be more permissive [#3486](https://github.com/jupyter-widgets/ipywidgets/p | Low | 7/27/2022 |
| 7.6.3 | # 7.6.3 A minor release in 7.6.x series. From changelog.md: # 7.6 To see the full list of pull requests and issues, see the [7.6.0 milestone](https://github.com/jupyter-widgets/ipywidgets/milestone/31?closed=1) on GitHub. The main change in this release is that installing `ipywidgets` 7.6.0 will now automatically enable ipywidgets support in JupyterLab 3.0—a user has no extra JupyterLab installation step and no rebuild of JupyterLab, nor do they need Node.js installed. Simply inst | Low | 2/7/2021 |
| 7.0.1 | See https://github.com/jupyter-widgets/ipywidgets/milestone/16?closed=1 | Low | 9/16/2017 |
| 6.0.0 | See http://blog.jupyter.org/2017/03/01/ipywidgets-6-release/ for the release announcement. | Low | 3/2/2017 |