File tree Expand file tree Collapse file tree 2 files changed +10
-3
lines changed Expand file tree Collapse file tree 2 files changed +10
-3
lines changed Original file line number Diff line number Diff line change 1
-
2
- # sidecar
1
+ # Sidecar
3
2
4
3
[ ![ Build Status] ( https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar.svg?branch=master )] ( https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar )
5
4
[ ![ codecov] ( https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar/branch/master/graph/badge.svg )] ( https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar )
6
5
7
-
8
6
A sidecar output widget for JupyterLab
9
7
10
8
## Installation
@@ -18,6 +16,9 @@ jupyter labextension install @jupyter-widgets/jupyterlab-sidecar
18
16
19
17
## Usage
20
18
19
+ The sidecar widget is used as a context manager, just like ipywidgets' output
20
+ widget.
21
+
21
22
``` python
22
23
from sidecar import Sidecar
23
24
from ipywidgets import IntSlider
@@ -27,3 +28,9 @@ sl = IntSlider(description='Some slider')
27
28
with sc:
28
29
display(sl)
29
30
```
31
+
32
+ When a single output is displayed in a Sidecar, it is allowed to occupy all of
33
+ the vertical space available. If more content is displayed, the natural height
34
+ is used instead.
35
+
36
+ ![ sidecar] ( sidecar.gif )
You can’t perform that action at this time.
0 commit comments