feat(docs): enhance Disk and Komorebi layout documentation

- Added `group_label` and `container_padding` options to Disk widget documentation, including detailed descriptions and example configurations. - Introduced a section for allowed callbacks in Komorebi layout documentation to clarify available functionalities.
amnweb · Jan 5, 2025 · 5f50b7d · 5f50b7d
1 parent 7591fca
commit 5f50b7d
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 1 deletion.
diff --git a/docs/widgets/(Widget)-Disk.md b/docs/widgets/(Widget)-Disk.md
@@ -6,7 +6,9 @@
 | `volume_label`       | string  | `'C'`        | Partition which you want to show in the bar |
 | `decimal_display` | integer | `1`                                                                  | The number of decimal to show, defaul 1 (min 0 max 3) |
 | `update_interval` | integer | `60`                                                                  | The interval in seconds to update the disk widget. Must be between 0 and 3600. |
+| `group_label` | dict | `{'enabled': False, 'volume_labels': ["C"], 'blur': True, 'alignment': 'right', 'direction': 'down', 'distance': 6}` | Group labels for multiple disks. This will show the labels of multiple disks in a popup window. |
 | `callbacks`       | dict    | `{'on_left': 'do_nothing', 'on_middle': 'do_nothing', 'on_right': "exec explorer C:\\"}` | Callbacks for mouse events. |
+| `container_padding`  | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}`      | Explicitly set padding inside widget container. |
 
 
 ## Example Configuration
@@ -19,6 +21,13 @@ disk:
       label_alt: "{volume_label} {space[used][gb]} / {space[total][gb]}"
       volume_label: "C"
       update_interval: 60
+      group_label:
+        enabled: true
+        volume_labels: ["C", "D", "E", "F"]
+        blur: true
+        alignment: 'center'
+        direction: 'down'
+        distance: 6
       callbacks:
         on_middle: "do_nothing"
         on_right: "exec explorer C:\\" # Open disk C in file explorer
@@ -31,14 +40,68 @@ disk:
 - **volume_label:** Partition/volume which you want to show in the bar.
 - **decimal_display:** The number of decimal to show, defaul 1 (min 0 max 3).
 - **update_interval:** The interval in seconds to update the disk widget. Must be between 0 and 3600.
+- **group_label:** Group labels for multiple disks. This will show the labels of multiple disks in a popup window.
+  - **enabled:** Enable group labels.
+  - **volume_labels:** List of volume labels to show in the group label.
+  - **blur:** Enable blur effect for the group label.
+  - **alignment:** Alignment of the group label. Possible values are `left`, `center`, and `right`.
+  - **direction:** Direction of the group label. Possible values are `up` and `down`.
+  - **distance:** Distance of the group label from the widget.
 - **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.
+- **container_padding:** Explicitly set padding inside widget container.
 
+> [!NOTE]
+> When `group_label` is enabled, the `callbacks`, `update_interval` and `label_alt` options will be ignored. Left mouse click on volume_label will open the disk in file explorer.
 
-## Example Style
+## Widget Style
 ```css
 .disk-widget {}
 .disk-widget .widget-container {}
 .disk-widget .widget-container .label {}
 .disk-widget .widget-container .label.alt {}
 .disk-widget .widget-container .icon {}
+/* Group label style */
+.disk-group {}
+.disk-group-row {}
+.disk-group-label {}
+.disk-group-label-size {}
+.disk-group-label-bar {}
+.disk-group-label-bar::chunk {}
+```
+
+## Example Style for Group Label
+```css
+.disk-group {
+    background-color:rgba(17, 17, 27, 0.75);
+}
+.disk-group-row {
+    min-width: 220px;
+    max-width: 220px;
+    max-height: 40px;
+    margin: 0;
+    padding: 0;
+    border-radius: 6px;
+    border: 1px solid rgba(128, 128, 128, 0);
+}
+.disk-group-row:hover {
+    background-color:rgba(255, 255, 255, 0.05);
+    border: 1px solid rgba(255, 255, 255, 0.1)
+}
+.disk-group-label-bar{
+    max-height:8px;
+    border:0px solid rgba(128, 128, 128, 0);
+    background-color: rgba(137, 180, 250, 0.1);
+    border-radius: 4px
+}
+.disk-group-label-bar::chunk{
+    background-color: rgba(137, 180, 250, 0.3);
+    border-radius: 4px
+}
+.disk-group-label {
+    font-size: 10px
+}
+.disk-group-label-size {
+    font-size: 10px;
+    color: #585b70
+}
 ```
diff --git a/docs/widgets/(Widget)-Komorebi-Layout.md b/docs/widgets/(Widget)-Komorebi-Layout.md
@@ -50,6 +50,21 @@ komorebi_active_layout:
 - **container_padding:** Explicitly set padding inside widget container.
 - **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.
 
+### Allowed Callbacks:
+```
+"next_layout"
+"prev_layout"
+"flip_layout"
+"flip_layout_horizontal"
+"flip_layout_vertical"
+"flip_layout_horizontal_and_vertical"
+"first_layout"
+"toggle_tiling"
+"toggle_float"
+"toggle_monocle"
+"toggle_maximise"
+"toggle_pause"
+```
 ## Example Style
 ```css
 .komorebi-active-layout {}