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.
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).
-
Install dependencies:
npm install
-
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
-
Build plugin in production mode:
npm run build
-
Run e2e tests:
npm run e2e