Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for opening sidecar in main area #115

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ or
conda install sidecar
```

If you use JupyterLab <=2:
If you use JupyterLab `<=2`:

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

![sidecar](sidecar.gif)
![sidecar in right panel (default)](sidecar.gif)


### Opening a sidecar in the main work area

By default, a sidecar will be displayed on the right panel, which has some limitations:
There is a maximum width, and it can't be displayed at the same time as other elements
in the right panel.

The `anchor` parameter can be used with values `'split-right'`, `'split-left'`,
`'split-top'`, `'split-bottom'`, `'tab-before'`, or `'tab-after'` to open a sidecar in a
new JupyterLab window which can be re-arranged as desired.

![sidecar in main work area](sidecar-main-area.gif)


## Development

Expand Down
Binary file added sidecar-main-area.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading