Skip to content

Files

panel-basic

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 11, 2025
Apr 11, 2024
Jul 5, 2024
Jan 31, 2025
Jul 9, 2024
Feb 11, 2025
Apr 11, 2024
Oct 25, 2023
Apr 14, 2022
Feb 15, 2022
Feb 15, 2022
Jan 19, 2024
May 16, 2024
Apr 14, 2022
Apr 14, 2022
Mar 28, 2025
Mar 28, 2025
Apr 11, 2024
Apr 14, 2022

Grafana Basic Panel Plugin example

This example provides a template for how to build a basic panel plugin. The definition for the panel is provided in /src/components/SimplePanel/SimplePanel.tsx.

The plugin uses TimeSeries from the grafana-ui package to build a graph with the properties passed to the panel. The plugin also allows a tooltip to be shown when the user hovers over a visualization.

Additionally, the plugin is set up to allow custom options such as a gradient mode selector and a list display mode to be configured from the Grafana sidebar.

What is a 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:

    npm install
  2. Build the plugin in development mode and run inside Grafana using Docker:

    # Start watching for changes
    npm run dev
    
    # Run Grafana inside a Docker container in a separate session
    docker-compose up
  3. Build plugin in production mode:

    npm run build
  4. Run e2e tests:

    npm run e2e

Learn more