/volkovlabs-dynamictext-panel

Business Text panel for @grafana

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Dynamic Text Panel for Grafana

Text

Grafana CI E2E codecov CodeQL

Introduction

Dynamic Text Panel is a Grafana visualization plugin that converts plain text and table data into visually appealing, easy-to-read information cards.

The Dynamic Text Panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.

Dynamic Text plugin for Grafana | Use HTML, Markdown, JavaScript and CSS | Community use cases

Requirements

  • Dynamic Text Panel 4.X requires Grafana 9.2 or Grafana 10.
  • Dynamic Text Panel 2.X and 3.X require Grafana 8.5 or Grafana 9.
  • Dynamic Text Panel 1.X requires Grafana 7.

Getting Started

You can install Dynamic Text Panel from the Grafana Plugins catalog or using the Grafana command line tool.

For the latter, please use the following command:

grafana-cli plugins install marcusolsson-dynamictext-panel

Highlights

  • Uses Monaco Code Editor with automatic formatting supporting templates, JS code snippets, and CSS styling.
  • Supports Markdown and Handlebars.
  • Renders markdown-it into HTML elements.
    • Supports the highlighting of code syntax using A11Y styles.
  • Provides code sanitization:
    • HTML inside templates is sanitized using XSS.
    • Can be disabled in the Grafana configuration through the disable_sanitize_html parameter.
  • Supports display of nested objects using the {{json object}} Handlebars helper.
  • Supports display of time global variables (__to and __from) as seconds, ISO timestamps, or formatted using the dayjs library.
  • Supports adding the Handlebars helpers and event handlers.
  • Supports adding CSS styles.
  • Supports internationalization using custom helpers.

Documentation

Section Description
Content Explains how to create a visualization template for your data.
Recipes Useful snippets that you can use in your templates.
Features Demonstrates panel features.templates.
Release Notes Stay up to date with the latest features and updates.

Feedback

We're looking forward to hearing from you. You can use different ways to get in touch with us.

  • Ask a question, request a new feature, or report an issue at GitHub issues.
  • Subscribe to our YouTube Channel and leave your comments.
  • Sponsor our open-source plugins for Grafana at GitHub Sponsor.
  • Support our project by starring the repository.

License

Apache License Version 2.0, see LICENSE.