Skip to content

Commit f65e708

Browse files
authored
Merge pull request #115 from mfisher87/document-sidecar-in-main-area
Add documentation for opening sidecar in main area
2 parents 78f0c5c + c1f0715 commit f65e708

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ or
1717
conda install sidecar
1818
```
1919

20-
If you use JupyterLab <=2:
20+
If you use JupyterLab `<=2`:
2121

2222
```bash
2323
jupyter labextension install @jupyter-widgets/jupyterlab-manager
@@ -43,7 +43,21 @@ When a single output is displayed in a Sidecar, it is allowed to occupy all of
4343
the vertical space available. If more content is displayed, the natural height
4444
is used instead.
4545

46-
![sidecar](sidecar.gif)
46+
![sidecar in right panel (default)](sidecar.gif)
47+
48+
49+
### Opening a sidecar in the main work area
50+
51+
By default, a sidecar will be displayed on the right panel, which has some limitations:
52+
There is a maximum width, and it can't be displayed at the same time as other elements
53+
in the right panel.
54+
55+
The `anchor` parameter can be used with values `'split-right'`, `'split-left'`,
56+
`'split-top'`, `'split-bottom'`, `'tab-before'`, or `'tab-after'` to open a sidecar in a
57+
new JupyterLab window which can be re-arranged as desired.
58+
59+
![sidecar in main work area](sidecar-main-area.gif)
60+
4761

4862
## Development
4963

sidecar-main-area.gif

17.9 MB
Loading

0 commit comments

Comments
 (0)