Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ Adds docs for widget labels (#769)

Lissy93869a5993e84f
diff --git a/docs/widgets.md b/docs/widgets.md
index 11557f77..8c55dca5 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -80,6 +80,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [Continuous Updates](#continuous-updates)
- [Proxying Requests](#proxying-requests)
- [Setting Timeout](#setting-timeout)
+ - [Adding Labels](#adding-labels)
- [Ignoring Errors](#ignoring-errors)
- [Custom CSS Styling](#widget-styling)
- [Customizing Charts](#customizing-charts)
@@ -2265,6 +2266,32 @@ For example:
---
+### Adding Labels
+
+If you have multiple widgets of the same type in a single section, it may not be clear what each one is. To overcome this, you can add a custom label to any given widget, using the `label` property.
+
+For example:
+
+```yaml
+- name: CPU Usage
+ icon: fas fa-tachometer
+ widgets:
+ - type: gl-current-cpu
+ label: Meida Server
+ options:
+ hostname: http://media-server.lan:61208
+ - type: gl-current-cpu
+ label: Firewall
+ options:
+ hostname: http://firewall.lan:61208
+ - type: gl-current-cpu
+ label: File Sync Server
+ options:
+ hostname: http://file-sync.lan:61208
+```
+
+---
+
### Ignoring Errors
When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.