Skip to content

nline/nline-guidedtour-panel

 
 

Repository files navigation

Guided tour panel for grafana dashboards

Add guided tour to your Grafana dashboards.

Disclaimer: This plugin is an EXPERIMENTAL plugin. Only tested against selected versions of grafana and specific use cases.

Guided tour panel cover image

Features

  • Add guided steps targeting dashboard panels
  • Customize the tour controller with custom markdown
  • Customize tour color theme and style
  • Support for grafana dark and light mode
  • Does support markdown content
  • Option to auto start the tour on dashboard load
  • Option to redirect to different dashboard at the end of the tour

Setup

  1. Add Guided Tour Panel to your dashboard like any other panel.
  2. Add as many steps required. Provide exact panel title for the step and then specify content. Content can be in markdown format.
  3. Customize the look and feel if required.

Known limitations

  • Panels you are navigating should be in viewport
  • Panels collapsed inside dashboard rows can't be targeted
  • Guided tour panel controller needs to be at the top of the dashboard or at least it should be in viewport

Packages

No packages published

Languages

  • TypeScript 83.7%
  • JavaScript 12.1%
  • Shell 2.1%
  • Dockerfile 2.1%