feat(docs): add Home widget documentation and update sidebar

amnweb · Nov 20, 2024 · 136e8d2 · 136e8d2
1 parent 91a3491
commit 136e8d2
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 3 deletions.
diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md
@@ -13,6 +13,7 @@
     - [Clock](./(Widget)-Clock)
     - [Custom](./(Widget)-Custom)
     - [Github](./(Widget)-Github)
+    - [Home](./(Widget)-Home)
     - [Disk](./(Widget)-Disk)
     - [Language](./(Widget)-Language)
     - [Libre Hardware Monitor](./(Widget)-Libre-HW-Monitor)

diff --git a/docs/assets/456789123-f4e5d6c7-89ab-4cde-1234-56789abcdef.png b/docs/assets/456789123-f4e5d6c7-89ab-4cde-1234-56789abcdef.png
diff --git a/docs/widgets/(Widget)-Custom.md b/docs/widgets/(Widget)-Custom.md
@@ -40,7 +40,7 @@ nvidia_temp:
     exec_options:
       run_cmd: "powershell nvidia-smi --query-gpu=temperature.gpu --format=csv,noheader"
       run_interval: 10000 # run every 10 sec
-      return_format: "string",
+      return_format: "string"
       hide_empty: false
 ```
 

diff --git a/docs/widgets/(Widget)-Home.md b/docs/widgets/(Widget)-Home.md
@@ -0,0 +1,74 @@
+# Home Menu Widget Configuration
+
+| Option          | Type    | Default                                                                 | Description                                                                 |
+|-----------------|---------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------|
+| `label`         | string  | `"\udb81\udf17"`                                | Icon or text for button. |
+| `menu_list`     | list    | `[]` | List of menu items. title and path |
+| `system_menu`   | boolean | `true`                                                                 | Show system menu. |
+| `power_menu`    | boolean | `true`                                                                 | Show power menu. |
+| `blur`          | boolean | `true`                                                                 | Blur background. |
+| `container_padding`  | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}`      | Explicitly set padding inside widget container. |
+
+## Example Configuration
+
+```yaml
+home:
+  type: "yasb.home.HomeWidget"
+  options:
+    label: "<span>\udb81\udf17</span>"
+    menu_list:
+    - { title: "User Home", path: "~" }
+    - { title: "Download", path: "D:\\Downloads" }
+    - { title: "Documents", path: "C:\\Users\\amn\\Documents" }
+    - { title: "Pictures", path: "C:\\Users\\amn\\Pictures" }
+    system_menu: true
+    power_menu: true
+    blur: true
+    container_padding: 
+      top: 0
+      left: 0
+      bottom: 0
+      right: 0
+```
+ 
+
+## Description of Options
+
+- **label**: Icon or text for button.
+- **menu_list**: List of menu items. title and path. Use this list only for directories, do not use it for applications or files.
+- **system_menu**: Show system menu. Enabling this option will show system menu items like settings, task manager and About this PC.
+- **power_menu**: Show power menu. Enabling this option will show power menu items like shutdown, restart, sleep, lock and sign out.
+- **blur**: Blur background. Enabling this option will blur the background and add default OS radius and border to the widget.
+
+## Example Style
+```css
+.home-widget {
+    padding: 0 4px 0 12px;
+}
+.home-widget .icon {
+    color: #b4befe;
+}
+.home-widget .icon:hover {
+    color: #cdd6f4;
+}
+.home-menu {
+    background-color:rgba(17, 17, 27, 0.5); 
+}
+.home-menu .menu-item {
+    padding: 6px 48px 7px 16px;
+    font-size: 12px;
+    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+    color: var(--text); 
+    font-weight: 600;
+}
+.home-menu .menu-item:hover {
+    background-color:rgba(128, 130, 158, 0.15);
+    color: #fff;
+}
+.home-menu:separator {
+    height: 1px;
+    background-color:rgba(128, 130, 158, 0.3);
+}
+```
+
+![Home YASB Widget](../assets/456789123-f4e5d6c7-89ab-4cde-1234-56789abcdef.png)
diff --git a/docs/widgets/(Widget)-Traffic.md b/docs/widgets/(Widget)-Traffic.md
@@ -13,8 +13,8 @@
 traffic:
   type: "yasb.traffic.TrafficWidget"
   options:
-    label: '\ueb01 \ueab4 {download_speed} | \ueab7 {upload_speed}'
-    label_alt: 'Download {download_speed} | Upload {upload_speed}'
+    label: "\ueb01 \ueab4 {download_speed} | \ueab7 {upload_speed}"
+    label_alt: "Download {download_speed} | Upload {upload_speed}"
     update_interval: 1000
     callbacks:
       on_left: 'toggle_label'