@oriolrius/grafana-business-text
Version:
Data-driven text with Markdown and Handlebars support for Grafana
91 lines (60 loc) • 5.94 kB
Markdown
# Business Text for Grafana
[](https://codecov.io/gh/VolkovLabs/business-text)
[](https://github.com/VolkovLabs/business-text/actions/workflows/codeql-analysis.yml)
## New Plugin Identifier
We’re excited to announce an update for the Business Text Panel! The latest version, fully compatible with Grafana 11 and Grafana 12, is now available under our new plugin ID: `volkovlabs-text-panel`. This enhancement ensures seamless integration and improved functionality for your dashboards.
To access the latest version and explore its features—such as dynamic text rendering, Markdown support, and JavaScript customization—please update your installations using the Grafana Plugins Catalog or the Grafana CLI with the new ID. For a step-by-step guide, visit our documentation or watch our latest tutorial video.
## Introduction
The Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.
[](https://youtu.be/UVMysEjouNo)
## Requirements
- Business Text panel 6.X requires **Grafana 11** or **Grafana 12**.
- Business Text panel 5.X requires **Grafana 10** or **Grafana 11**.
- 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 the Business Text panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/volkovlabs-text-panel/) or use the Grafana command line tool.
For the latter, please use the following command:
```bash
grafana cli plugins install volkovlabs-text-panel
```
[](https://youtu.be/1qYzHfPXJF8)
## Highlights
- Uses Monaco Code Editor with automatic JavaScript code formatting.
- Supports [Markdown](https://commonmark.org/help/) and [Handlebars](https://handlebarsjs.com/guide/expressions.html#basic-usage).
- Renders [markdown-it](https://github.com/markdown-it/markdown-it) into HTML elements.
- Supports the highlighting of code syntax using A11Y styles.
- Provides code sanitization:
- HTML inside templates is sanitized using [XSS](https://jsxss.com/en/index.html).
- 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 with dashboard variables.
- Supports internationalization using custom helpers.
- **Data Source Query Integration** - Execute queries against Grafana data sources directly from JavaScript code. [Learn more](docs/DATASOURCE_INTEGRATION.md)
## Documentation
| Section | Description |
| --------------------------------------------------------------------- | ------------------------------------------------------------- |
| [Rendering](https://volkovlabs.io/plugins/business-text/content/) | Explains how to create a visualization template for your data |
| [Recipes](https://volkovlabs.io/plugins/business-text/recipes/) | Useful snippets that you can use in your templates |
| [Features](https://volkovlabs.io/plugins/business-text/features/) | Demonstrates panel features.templates |
| [Tutorials](https://volkovlabs.io/plugins/business-text/tutorials/) | Easy to follow tutorials |
| [Release Notes](https://volkovlabs.io/plugins/business-text/release/) | Stay up to date with the latest features and updates |
## Business Suite for Grafana
The Business Suite is a collection of open source plugins created and actively maintained by Volkov Labs.
The collection aims to solve the most frequent business tasks by providing an intuitive interface with detailed written documentation, examples, and video tutorials.
[](https://volkovlabs.io/plugins/)
### Enterprise Support
With the [Business Suite Enterprise](https://volkovlabs.io/pricing/), you're not just getting a product, you're getting a complete support system. You'll have a designated support team ready to tackle any issues.
You can contact us via Zendesk, receive priority in feature requests and bug fixes, meet with us for in-person consultation, and get access to the Business Intelligence. It's a package that's designed to make your life easier.
## Always happy to hear from you
- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/business-text/issues).
- Subscribe to our [YouTube Channel](https://youtube.com/@volkovlabs) and leave your comments.
## License
Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/business-text/blob/main/LICENSE).