Skip to content

Commit 8fe788b

Browse files
committed
Add screencast
1 parent dafecf7 commit 8fe788b

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
2-
# sidecar
1+
# Sidecar
32

43
[![Build Status](https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar.svg?branch=master)](https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar)
54
[![codecov](https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar)
65

7-
86
A sidecar output widget for JupyterLab
97

108
## Installation
@@ -18,6 +16,9 @@ jupyter labextension install @jupyter-widgets/jupyterlab-sidecar
1816

1917
## Usage
2018

19+
The sidecar widget is used as a context manager, just like ipywidgets' output
20+
widget.
21+
2122
```python
2223
from sidecar import Sidecar
2324
from ipywidgets import IntSlider
@@ -27,3 +28,9 @@ sl = IntSlider(description='Some slider')
2728
with sc:
2829
display(sl)
2930
```
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)

sidecar.gif

3.1 MB
Loading

0 commit comments

Comments
 (0)