From 54e7b20e7ed69059b318a2980effb88974372a7a Mon Sep 17 00:00:00 2001
From: amnweb <16545063+forumwt@users.noreply.github.com>
Date: Wed, 29 Jan 2025 23:39:51 +0100
Subject: [PATCH] docs(widget/traffic): update documentation to include
hide_if_offline and max_label_length options
---
docs/widgets/(Widget)-Traffic.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/widgets/(Widget)-Traffic.md b/docs/widgets/(Widget)-Traffic.md
index 980c7bd..5b3e473 100644
--- a/docs/widgets/(Widget)-Traffic.md
+++ b/docs/widgets/(Widget)-Traffic.md
@@ -6,6 +6,8 @@
| `label_alt` | string | `'Download {download_speed} - Upload {upload_speed}'` | The alternative format string for the traffic widget. Displays upload and download speeds. |
| `update_interval` | integer | `1000` | The interval in milliseconds to update the traffic data. Must be between 0 and 60000. |
| `interface` | string | `Auto` | The network interface to monitor. If not specified, the widget will use the default interface. |
+| `hide_if_offline` | boolean | `False` | Hide the widget if the network interface is offline. |
+| `max_label_length` | integer | `0` | The maximum length of the label. |
| `callbacks` | dict | `{'on_left': 'toggle_label', 'on_middle': 'do_nothing', 'on_right': 'do_nothing'}` | Callbacks for mouse events on the traffic widget. |
| `animation` | dict | `{'enabled': True, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
| `container_padding` | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}` | Explicitly set padding inside widget container. |
@@ -29,6 +31,8 @@ traffic:
- **label_alt:** The alternative format string for the traffic widget. Displays upload and download speeds.
- **update_interval:** The interval in milliseconds to update the traffic data. Must be between 0 and 60000.
- **interface:** The network interface to monitor. If not specified, the widget will use the default interface.
+- **hide_if_offline:** Hide the widget if the network interface is offline.
+- **max_label_length:** The maximum length of the label.
- **callbacks:** A dictionary specifying the callbacks for mouse events. The keys are `on_left`, `on_middle`, and `on_right`, and the values are the names of the callback functions.
- **animation:** A dictionary specifying the animation settings for the widget. It contains three keys: `enabled`, `type`, and `duration`. The `type` can be `fadeInOut` and the `duration` is the animation duration in milliseconds.
- **container_padding**: Explicitly set padding inside widget container. Use this option to set padding inside the widget container. You can set padding for top, left, bottom and right sides of the widget container.