Skip to content

Commit c25d3cc

Browse files
authored
Merge pull request #3047 from jasongrout/updatewidget
Update changelog with instructions for widget maintainers.
2 parents 249a7cc + b729417 commit c25d3cc

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
${{ runner.os }}-yarn-
4444
- name: Install dependencies
4545
run: |
46-
python -m pip install --pre jupyterlab~=3.0.0rc4
46+
python -m pip install jupyterlab~=3.0
4747
python -m pip install jupyter_packaging
4848
- name: Build the extension
4949
run: |

docs/source/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ The main change in this release is that installing `ipywidgets` 7.6.0 will now a
1212

1313
This is accomplished with the new python package `jupyterlab_widgets` version 1.0, on which `ipywidgets` 7.6.0 now depends (similar to how `ipywidgets` already depends on the `widgetsnbextension` package to configure ipywidgets for the classic Jupyter Notebook). The `jupyterlab_widgets` Python package is a JupyterLab 3.0 prebuilt extension, meaning that it can be installed into JupyterLab 3.0 without rebuilding JupyterLab and without needing Node.js installed.
1414

15+
### Updates for Widget Maintainers
16+
17+
Custom widget maintainers will need to update their `@jupyter-widgets/base` dependency version to work in JupyterLab 3.0. For example, if you had a dependency on `@jupyter-widgets/base` version `^2 || ^3`, update to `^2 || ^3 || ^4` for your widget to work in classic Jupyter Notebook, JupyterLab 1, JupyterLab 2, and JupyterLab 3. See [#2472](https://github.com/jupyter-widgets/ipywidgets/pull/2472) for background.
18+
19+
Separately from this update of the version of the `@jupyter-widgets/base` dependency version range, you might consider making your widget's JupyterLab extension a prebuilt extension for JupyterLab 3.0. Users will be able to install your JupyterLab 3.0 prebuilt extension without rebuilding JupyterLab or needing Node.js. See the [JupyterLab 3 extension developer documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html) or the new [widget extension cookiecutter](https://github.com/jupyter-widgets/widget-ts-cookiecutter) for more details.
20+
1521

1622
7.5
1723
---

0 commit comments

Comments
 (0)