# jupyterlab-interactive-dashboard-editor

> Interactively create and customize dashboards in JupyterLab

Latest version **0.4.0** (published 2021-01-27) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install jupyterlab-interactive-dashboard-editor
pnpm add jupyterlab-interactive-dashboard-editor
yarn add jupyterlab-interactive-dashboard-editor
bun add jupyterlab-interactive-dashboard-editor
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2021-01-27 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 690 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 221 |
| Author | jupytercalpoly |
| Maintainers | jessica_jiayi_xu, camerontoy |
| Keywords | jupyter, jupyterlab, jupyterlab-extension |

## Links

- npm: https://www.npmjs.com/package/jupyterlab-interactive-dashboard-editor
- Repository: https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor
- Issues: https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/issues
- npm.io page: https://npm.io/package/jupyterlab-interactive-dashboard-editor

## Dependencies (13)

- [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^1.16.1
- [@lumino/dragdrop](https://npm.io/package/@lumino/dragdrop.md) ^1.7.1
- [@jupyterlab/cells](https://npm.io/package/@jupyterlab/cells.md) ^3.0.3
- [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^1.5.3
- [@lumino/datastore](https://npm.io/package/@lumino/datastore.md) ^0.10.3
- [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^3.0.2
- [@jupyterlab/launcher](https://npm.io/package/@jupyterlab/launcher.md) ^3.0.2
- [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^3.0.2
- [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^3.0.3
- [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^6.0.2
- [@jupyterlab/coreutils](https://npm.io/package/@jupyterlab/coreutils.md) ^5.0.1
- [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^3.0.3
- [@jupyterlab/ui-components](https://npm.io/package/@jupyterlab/ui-components.md) ^3.0.2

## Recent versions

- 0.4.0 (latest) — 2021-01-27
- 0.3.1 — 2020-08-26
- 0.3.0 — 2020-08-26
- 0.2.0 — 2020-08-17
- 0.1.0 — 2020-08-10

## README

# jupyterlab-interactive-dashboard-editor

![Github Actions Status](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/workflows/Build/badge.svg)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-interactive-dashboard-editor/master?urlpath=lab)
[![npm version](https://badge.fury.io/js/jupyterlab-interactive-dashboard-editor.svg)](https://www.npmjs.com/package/jupyterlab-interactive-dashboard-editor)
[![Documentation Status](https://readthedocs.org/projects/jupyterlab-interactive-dashboard-editor/badge/?version=latest)](https://jupyterlab-interactive-dashboard-editor.readthedocs.io/en/latest/?badge=latest)

Interactively create and customize dashboards in JupyterLab

![presto-overview](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/overview.gif)

## Additional Gifs
<details>
  <summary>Click to expand</summary>
  Add and rearrange outputs on dashboards right from your notebook.

  ![add-move-resize](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/add_move_resize.gif)

  Add outputs from multiple notebooks.

  ![add-multiple](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/multiple_notebooks.gif)

  See changes immediately.

  ![see-changes](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/update_cells.gif)

  Preview your dashboard and interact with widgets in present mode.

  ![present-mode](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/present_edit.gif)

  Undo and redo.

  ![undo-redo](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/undo_redo.gif)

  Add markdown too.

  ![markdown-too](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/markdown_too.gif)

  Save dashboards to file,

  ![save-dashboard](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/save.gif)

  Load them up,

  ![load-dashboard](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/load.gif)

  And edit them again!

  ![edit-again](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/blob/master/Design/gifs/edit_again.gif)
</details>

## Requirements

* JupyterLab >= 2.0

## Install

Note: You will need NodeJS to install the extension.

```bash
pip install jupyterlab_interactive_dashboard_editor
jupyter lab build
```

### Install

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.

```bash
# Clone the repo to your local environment
# Move to jupyterlab-interactive-dashboard-editor directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

### Uninstall

```bash
jupyter labextension uninstall jupyterlab-interactive-dashboard-editor
```

---
_Source: https://npm.io/package/jupyterlab-interactive-dashboard-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
