Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel
Grafana Panel for adding styles
https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel
grafana grafana-panel grafana-plugin grafana-theme
Last synced: about 1 month ago
JSON representation
Grafana Panel for adding styles
- Host: GitHub
- URL: https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel
- Owner: yesoreyeram
- License: apache-2.0
- Created: 2019-04-29T10:05:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T07:04:20.000Z (about 1 year ago)
- Last Synced: 2024-05-01T14:59:15.177Z (8 months ago)
- Topics: grafana, grafana-panel, grafana-plugin, grafana-theme
- Language: TypeScript
- Homepage: http://yesoreyeram.github.io/yesoreyeram-boomtheme-panel
- Size: 1.55 MB
- Stars: 87
- Watchers: 5
- Forks: 13
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# :warning: DEPRECATION
Grafana Boom Theme Panel was created during early Grafana days to workaround theme support for Grafana dashbaords. Given that Grafana have native themes now, It is time to deprecate the plugin.
Thank you community for the support. This plugin will be removed/archived from the grafana plugin catalog. Existing installations should continue to work. If that doesn't work, reach out to [community.grafana.com](https://community.grafana.com) for support. You can also download old binaries from [releases page](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases).
# Boom Theme Panel
[](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/actions?query=workflow%3A%22Build+%26+Publish%22)
[](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/actions?query=workflow%3ARelease)
Theme switcher with custom styles / themes for grafana dashboards.
## Features
- Theme switcher
- Multiple themes per dashboard
- Theme builder
- External stylesheets support
- Add inline styles to themes to override styles
- Add many themes as possible without rebuilding / restarting grafana
- Users can change the themes without editing the dashboard
- Dashboard specific themes
## Creating Theme
Themes can be created with multiple building blocks like background image, base theme etc.
| Property | Description |
| --------------------------- | -------------------------------------------------------------------------------------------------------- |
| Base theme | Themes can be built on top of default/dark/light theme. Default is **Default Theme** |
| Background image | Optional property. Can be blank. If specified more than once, last wins. Value should be valid image URL |
| CSS url | External theme file. Should be valid CSS file URL |
| Custom Style / CSS Override | CSS Styles. Should be valid css |
| Panel container BG | Background color for the panels |
## Supported Grafana version
This grafana plugin is tested with the following grafana versions, But other versions are also expected to work.
- Grafana version 8.x
- Grafana version 7.x
- Grafana version 6.x
## Notes
- When adding external stylesheets, make sure CORS enabled for those domains.
- To make panel invisible : Modify following theme panel settings:
- transparent = true
- title = ""
- Disable Theme Picker using panel settings
- Move this panel to the bottom of the dashboard
- Adjust the height and width if required.
## Known issues / Limitations
- If any custom plugin is used, dark/light theme switch, base theme will not work for those custom plugins. Refer [this](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/issues/3) github issue
- Theme panel should be within view port. Otherwise, Grafana won't render the theme. Refer [this](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/issues/17)
## Installation Instructions
There are multiple ways to install this plugin into your grafana instance
### Download and extract zip file
Download the zip file from [github releases page](https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases) and extract into your grafana plugin folder. Then restart Grafana.
### Using grafana-cli
If you are using grafana-cli, execute the following command to install the plugin
```sh
grafana-cli plugins install yesoreyeram-boomtheme-panel
```
or for specific versions
```sh
grafana-cli --pluginUrl https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases/download/v0.2.1/yesoreyeram-boomtheme-panel-0.2.1.zip plugins install yesoreyeram-boomtheme-panel
```
### Using helm chart
If you use helm chart to provision grafana, use the following config to install the plugin
```yml
plugins:
- yesoreyeram-boomtheme-panel
```
or for any specific versions
```yml
plugins:
- https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases/download/v0.2.1/yesoreyeram-boomtheme-panel-0.2.1.zip;yesoreyeram-boomtheme-panel
```