Jupyter Widgets JupyterLab Extension ====================================
A JupyterLab 3.0 extension for Jupyter/IPython widgets.
## Installation
To enable ipywidgets support in JupyterLab 3.x:
<div class="codehilite">
<pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>jupyterlab_widgets
</code></pre>
</div>
### 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/[email protected]`
* For JupyterLab 0.31rc1, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.31rc2, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.31.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.32.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.33.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.34.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 0.35.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 1.0.x and 1.1.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* For JupyterLab 1.2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
* 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.
<div class="codehilite">
<pre><span></span><code><span class="c1"># Clone the repo to your local environment</span>
<span class="c1"># Change directory to the jupyterlab_widgets directory</span>
<span class="c1"># Install package in development mode</span>
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
<span class="c1"># Link your development version of the extension with JupyterLab</span>
jupyter<span class="w"> </span>labextension<span class="w"> </span>develop<span class="w"> </span>.<span class="w"> </span>--overwrite
<span class="c1"># Rebuild extension Typescript source after making changes</span>
jlpm<span class="w"> </span>run<span class="w"> </span>build
</code></pre>
</div>
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.
<div class="codehilite">
<pre><span></span><code><span class="c1"># Watch the source directory in one terminal, automatically rebuilding when needed</span>
jlpm<span class="w"> </span>run<span class="w"> </span>watch
<span class="c1"># Run JupyterLab in another terminal</span>
jupyter<span class="w"> </span>lab
</code></pre>
</div>
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
<div class="codehilite">
<pre><span></span><code>pip<span class="w"> </span>uninstall<span class="w"> </span>jupyterlab_widgets
</code></pre>
</div>