panel-basic

Basic Panel Plugin

This is an example on how to build a basic panel plugin.

What is Grafana Panel Plugin?

Panel plugins allow you to add new types of visualizations to your dashboard, such as maps, clocks, pie charts, lists, and more.

Use panel plugins when you want to do things like visualize data returned by data source queries, navigate between dashboards, or control external systems (such as smart home devices).

Getting started

1. Install dependencies

   yarn install

2. Build plugin in development mode and run inside Grafana using Docker

   # Start watching for changes
   yarn dev
   
   # Run Grafana inside a docker container in a separate session
   docker-compose up

3. Build plugin in production mode

   yarn build

4. Run e2e tests

   yarn e2e

Learn more

• Build a panel plugin tutorial
• Grafana documentation
• Grafana Tutorials - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
• Grafana UI Library - UI components to help you build interfaces using Grafana Design System