@grafana/scenes
v5.24.0
Published
Grafana framework for building dynamic dashboards
Downloads
91,551
Maintainers
Keywords
Readme
About @grafana/scenes
@grafana/scenes provides a library to build highly interactive, dashboard-like experiences in Grafana's app plugins. It comes with the following features:
- Versatile layout options.
- Grafana panels rendering.
- Querying & transformations support
- Multiple time ranges support.
- Template variables support.
- URL sync.
- ... and more.
For library documentation go to https://grafana.com/developers/scenes.
Development
To work on @grafana/scenes SDK, please follow the guides below.
Setting up @grafana/scenes with a local Grafana instance
To setup scenes with local Grafana, the following setup is required:
- Clone the Grafana Scenes repository.
- Clone the Grafana repository and follow the Development guide.
- Setup env variable
GRAFANA_PATH
to point to your Grafana repository directory,export GRAFANA_PATH=<path-to-grafana-directory>
- From Grafana Scenes root directory run
./scripts/dev.sh
. This will compile @grafana/scenes with watch mode enabled and link it to your Grafana. - From Grafana directory run
yarn install
.
Setting up local version of @grafana/scenes with app plugin
- Run
YARN_IGNORE_PATH=1 yarn link
frompackages/scenes
directory. - Run
yarn dev
frompackages/scenes
directory. - Run
yarn link @grafana/scenes
from app plugin directory. - Start app plugin development server.
Demo app
Alternatively, use the demo app included in this repository.