Skip to content

Commit 6f36a7a

Browse files
committed
docs(widget): add option for label at center of progress bar
1 parent 2026be1 commit 6f36a7a

File tree

8 files changed

+17
-8
lines changed

8 files changed

+17
-8
lines changed

docs/widgets/(Widget)-Brightness.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
| `animation` | dict | `{'enabled': True, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
2121
| `container_shadow` | dict | `None` | Container shadow options. |
2222
| `label_shadow` | dict | `None` | Label shadow options. |
23-
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', animation: True}` | Progress bar settings. |
23+
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', animation: True, 'center_label': ''}` | Progress bar settings. |
2424
## Example Configuration
2525

2626
```yaml
@@ -95,13 +95,15 @@
9595
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
9696
- **background_color**: The background color of the progress bar.
9797
- **animation**: Whether to enable smooth change of the progress bar value.
98+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
9899

99100
## Example Style
100101
```css
101102
.brightness-widget {}
102103
.brightness-widget .widget-container {}
103104
.brightness-widget .widget-container .label {}
104105
.brightness-widget .widget-container .icon {}
106+
.brightness-widget .progress-circle {}
105107
```
106108

107109
## Style for the brightness menu

docs/widgets/(Widget)-CPU.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
| `animation` | dict | `{'enabled': true, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
1414
| `container_shadow` | dict | `None` | Container shadow options. |
1515
| `label_shadow` | dict | `None` | Label shadow options. |
16-
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false}` | Progress bar settings. |
16+
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false, 'center_label': ''}` | Progress bar settings. |
1717
| `hide_decimal` | bool | `false` | Whether to hide decimal places in the CPU widget. |
1818

1919
## Example Configuration
@@ -71,6 +71,7 @@ cpu:
7171
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
7272
- **background_color**: The background color of the progress bar.
7373
- **animation**: Whether to enable smooth change of the progress bar value.
74+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
7475

7576
## Available Placeholders
7677

docs/widgets/(Widget)-Disk.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
| `animation` | dict | `{'enabled': true, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
1414
| `container_shadow` | dict | `None` | Container shadow options. |
1515
| `label_shadow` | dict | `None` | Label shadow options. |
16-
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false}` | Progress bar settings. |
16+
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false, 'center_label': ''}` | Progress bar settings. |
1717

1818
## Example Configuration
1919

@@ -81,6 +81,7 @@ disk:
8181
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
8282
- **background_color**: The background color of the progress bar.
8383
- **animation**: Whether to enable smooth change of the progress bar value.
84+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
8485

8586
## Widget Style
8687
```css

docs/widgets/(Widget)-GPU.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you see a table with your GPU information, `nvidia-smi` is available. If you
2727
| `animation` | dict | `{'enabled': true, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
2828
| `container_shadow` | dict | `{"enabled": False, "color": "black", "offset": [1, 1], "radius": 3}` | Container shadow options. |
2929
| `label_shadow` | dict | `{"enabled": False, "color": "black", "offset": [1, 1], "radius": 3}` | Label shadow options. |
30-
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false}` | Progress bar settings. |
30+
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': false, 'center_label': ''}` | Progress bar settings. |
3131
| `hide_decimal` | bool | `false` | Whether to hide decimal places in the GPU widget. |
3232

3333
> **About `index`:** If you have multiple NVIDIA GPUs, you can set the `gpu_index` option to select which GPU to monitor. Create multiple GPU widgets with different `gpu_index` values (e.g., 0, 1, 2, ...) to display stats for each card separately.
@@ -82,6 +82,7 @@ gpu:
8282
- **color**: The color of the progress bar. Color can be single color or gradient.
8383
- **background_color**: The background color of the progress bar.
8484
- **animation**: Whether to enable smooth change of the progress bar value.
85+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
8586

8687
## Available Placeholders
8788

docs/widgets/(Widget)-Memory.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| `animation` | dict | `{'enabled': true, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
1212
| `container_shadow` | dict | `None` | Container shadow options. |
1313
| `label_shadow` | dict | `None` | Label shadow options. |
14-
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': True}` | Progress bar settings. |
14+
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': True, 'center_label': ''}` | Progress bar settings. |
1515
| `hide_decimal` | boolean | `false` | Whether to hide decimal places in the memory widget. |
1616

1717
## Example Configuration
@@ -69,6 +69,7 @@ memory:
6969
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
7070
- **background_color**: The background color of the progress bar.
7171
- **animation**: Whether to enable smooth change of the progress bar value.
72+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
7273

7374
The `label` and `label_alt` options use format strings that can include placeholders for memory metrics. These placeholders will be replaced with actual values when the widget is rendered. You can use `{virtual_mem_free}`, `{virtual_mem_percent}`, `{virtual_mem_total}`, `{virtual_mem_avail}`, `{virtual_mem_used}`, `{virtual_mem_outof}`, `{swap_mem_free}`, `{swap_mem_percent}`, `{swap_mem_total}`
7475

docs/widgets/(Widget)-Microphone.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| `container_shadow` | dict | `None` | Container shadow options. |
1515
| `label_shadow` | dict | `None` | Label shadow options. |
1616
| `mic_menu` | dict | `{'blur': True, 'round_corners': True, 'round_corners_type': 'normal', 'border_color': 'system', 'alignment': 'right', 'direction': 'down', 'offset_top': 6, 'offset_left': 0}` | Menu settings for the widget. |
17-
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', animation: True}` | Progress bar settings. |
17+
| `progress_bar` | dict | `{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', animation: True, 'center_label': ''}` | Progress bar settings. |
1818

1919

2020
## Example Configuration
@@ -76,6 +76,7 @@ microphone:
7676
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
7777
- **background_color**: The background color of the progress bar.
7878
- **animation**: Whether to enable smooth change of the progress bar value.
79+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
7980

8081
## Example Style
8182
```css

docs/widgets/(Widget)-Pomodoro.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This widget implements a Pomodoro timer, which is a time management method that
2222
| `menu` | dict | See below | Configure the appearance and behavior of the timer menu. |
2323
| `container_shadow` | dict | `None` | Container shadow options. |
2424
| `label_shadow` | dict | `None` | Label shadow options. |
25-
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': true}` | Progress bar settings. |
25+
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': true, 'center_label': ''}` | Progress bar settings. |
2626

2727
## Example Configuration
2828

@@ -115,6 +115,7 @@ pomodoro:
115115
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]"` for a gradient.
116116
- **background_color**: The background color of the progress bar.
117117
- **animation**: Whether to enable smooth change of the progress bar value.
118+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
118119

119120
## Available Callbacks
120121

docs/widgets/(Widget)-Volume.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| `animation` | dict | `{'enabled': True, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
1515
| `container_shadow` | dict | `None` | Container shadow options. |
1616
| `label_shadow` | dict | `None` | Label shadow options. |
17-
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': true}` | Progress bar settings. |
17+
| `progress_bar` | dict | `{'enabled': false, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', 'animation': true, 'center_label': ''}` | Progress bar settings. |
1818

1919

2020
## Example Configuration
@@ -79,6 +79,7 @@ volume:
7979
- **color**: The color of the progress bar. Color can be single color or gradient. For example, `color: "#57948a"` or `color: ["#57948a", "#ff0000"]` for a gradient.
8080
- **background_color**: The background color of the progress bar.
8181
- **animation**: Whether to enable smooth change of the progress bar value.
82+
- **center_label**: The label that will be centered inside the progress bar (can be styled using `.progress-circle`)
8283

8384
## Example Style
8485
```css

0 commit comments

Comments
 (0)