Skip to content

Commit 53b6f7c

Browse files
authored
Merge pull request #110 from azinsharaf/fixing-typo
docs(clock): fixing a typo
2 parents 4345f0b + e521360 commit 53b6f7c

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

docs/widgets/(Widget)-Clock.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Clock Widget Configuration
22

3-
| Option | Type | Default | Description |
4-
|-----------------|---------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------|
5-
| `label` | string | `'\uf017 {%H:%M:%S}'` | The format string for the clock. You can use placeholders like `{%H:%M:%S}` to dynamically insert time information. |
6-
| `label_alt` | string | `'\uf017 {%d-%m-%y %H:%M:%S}'` | The alternative format string for the clock. Useful for displaying additional time details. |
7-
| `tooltip` | boolean | `True` | Whether to show the tooltip on hover. |
8-
| `locale` | string | `""` | The locale to use for the clock. If not specified, it defaults to an empty string. |
9-
| `update_interval` | integer | `1000` | The interval in milliseconds to update the clock. Must be between 0 and 60000. |
10-
| `timezones` | list | `[]` | A list of timezones to cycle through. Each timezone should be a valid timezone string. |
11-
| `callbacks` | dict | `{'on_left': 'toggle_label', 'on_middle': 'do_nothing', 'on_right': 'next_timezone'}` | Callbacks for mouse events on the clock widget. |
12-
| `animation` | dict | `{'enabled': True, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
13-
| `container_padding` | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}` | Explicitly set padding inside widget container. |
3+
| Option | Type | Default | Description |
4+
| ------------------- | ------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
5+
| `label` | string | `'\uf017 {%H:%M:%S}'` | The format string for the clock. You can use placeholders like `{%H:%M:%S}` to dynamically insert time information. |
6+
| `label_alt` | string | `'\uf017 {%d-%m-%y %H:%M:%S}'` | The alternative format string for the clock. Useful for displaying additional time details. |
7+
| `tooltip` | boolean | `True` | Whether to show the tooltip on hover. |
8+
| `locale` | string | `""` | The locale to use for the clock. If not specified, it defaults to an empty string. |
9+
| `update_interval` | integer | `1000` | The interval in milliseconds to update the clock. Must be between 0 and 60000. |
10+
| `timezones` | list | `[]` | A list of timezones to cycle through. Each timezone should be a valid timezone string. |
11+
| `callbacks` | dict | `{'on_left': 'toggle_label', 'on_middle': 'do_nothing', 'on_right': 'next_timezone'}` | Callbacks for mouse events on the clock widget. |
12+
| `animation` | dict | `{'enabled': True, 'type': 'fadeInOut', 'duration': 200}` | Animation settings for the widget. |
13+
| `container_padding` | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}` | Explicitly set padding inside widget container. |
1414

1515
## Example Configuration
1616

1717
```yaml
1818
clock:
1919
type: "yasb.clock.ClockWidget"
2020
options:
21-
label: "uf017 {%H:%M:%S}"
21+
label: "\uf017 {%H:%M:%S}"
2222
label_alt: "\uf017 {%d-%m-%y %H:%M:%S}"
2323
locale: ""
2424
update_interval: 1000
@@ -30,6 +30,7 @@ clock:
3030
```
3131
3232
## Description of Options
33+
3334
- **label:** The format string for the clock. You can use placeholders like `{%H:%M:%S}` to dynamically insert time information.
3435
- **label_alt:** The alternative format string for the clock. Useful for displaying additional time details.
3536
- **locale:** The locale to use for the clock. If not specified, it defaults to an empty string.
@@ -43,10 +44,17 @@ clock:
4344
Clock format https://docs.python.org/3/library/time.html#time.strftime
4445

4546
## Example Style
47+
4648
```css
47-
.clock-widget {}
48-
.clock-widget .widget-container {}
49-
.clock-widget .widget-container .label {}
50-
.clock-widget .widget-container .label.alt {}
51-
.clock-widget .widget-container .icon {}
52-
```
49+
.clock-widget {
50+
}
51+
.clock-widget .widget-container {
52+
}
53+
.clock-widget .widget-container .label {
54+
}
55+
.clock-widget .widget-container .label.alt {
56+
}
57+
.clock-widget .widget-container .icon {
58+
}
59+
```
60+

0 commit comments

Comments
 (0)