Skip to content

multics/volkovlabs-dynamictext-panel

 
 

Repository files navigation

Dynamic Text Panel for Grafana

Text

Grafana CI E2E codecov CodeQL

Introduction

A Dynamic Text visualization panel is a Grafana plugin that transforms monotone text/table data into vibrant, easy-to-read information cards. The panel supports variables, Markdown and Handlebars.

The Dynamic Text visualization panel lets you define a text template using the data from your data source query.

Dynamic Text Plugin for Grafana | Markdown, HTML and Handlebars to transform data visualizations

Requirements

  • Grafana 9 and Grafana 10 are required for major version 4.
  • Grafana 8.5 and Grafana 9 are required for major versions 2 and 3.
  • Grafana 7 is required for major version 1.

Getting Started

The Dynamic Text visualization panel can be installed from the Grafana Catalog or utilizing the Grafana command line tool.

For the latter, use the following command.

grafana-cli plugins install marcusolsson-dynamictext-panel

Highlights

  • Uses Monaco Code Editor with Auto formatting to update Templates, JavaScript Code and Styles.
  • Supports Markdown and Handlebars.
  • Uses markdown-it for rendering Markdown to HTML.
    • Supports Code syntax highlight using a11y styles.
  • Sanitizing
    • HTML inside templates is sanitized using XSS.
    • Can be disabled using Grafana configuration disable_sanitize_html.
  • Allows to display nested objects using {{json object}} Handlebars helper.
  • Allows displaying Time global variables (__to and __from) as seconds, ISO, and formatted using dayjs.
  • Allows adding Handlebars helpers and Event handlers.
  • Allows adding CSS styles.

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.

Tutorial

This video outlines all the new features we implemented, including the most asked-for JavaScript area code.

JavaScript code in the Dynamic text panel | Grafana functionality explodes

Three plugins that make Grafana complete. Dynamic Text, Data Manipulation, and Apache ECharts are all you need to create functional real-world web applications.

Magic JavaScript trio for Grafana | Dynamic Text, Data Manipulation and Apache ECharts plugins

Feedback

We love to hear from you. There are various ways to get in touch with us.

  • Ask a question, request a new feature, and file a bug with GitHub issues.
  • Subscribe to our YouTube Channel and add a comment.
  • Sponsor our open-source plugins for Grafana with GitHub Sponsor.
  • Star the repository to show your support.

License

Apache License Version 2.0, see LICENSE.

About

A dynamic, data-driven text for @grafana.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 96.3%
  • JavaScript 3.7%