@grafana/scenes

Create dashboard-like experiences in Grafana app plugins

Important notice

@grafana/scenes is in its early days. We do not encourage anyone to use it in plugins yet. APIs can (and probably will) change significantly in the months to come.

Development

Working with Grafana

@grafana/scenes does not come with dedicated playground yet. It is currently possible to run Scene demos using Grafana. To do that, the following setup is required.

1. Clone @grafana/scenes repository.
2. Clone Grafana repository and follow Development guide.
3. Setup env variable GRAFANA_PATH to point to your Grafana repository directory, export GRAFANA_PATH=<path-to-grafana-directory>
4. From @grafana/scenes directory run ./scripts/dev.sh. This will compile @grafana/scenes with watch mode enabled and link it to your Grafana.
5. From Grafana directory run yarn install.
6. Start Grafana with scenes feature toggle enabled
7. Navigate to http://localhost:3000/scenes to explore demo scenes.

Working with Grafana app plugin

1. Run YARN_IGNORE_PATH=1 yarn link from @grafana/scenes directory.
2. Run yarn dev from @grafana/scenes directory.
3. Run yarn link @grafana/scenes from app plugin directory.
4. Start app plugin development server.