Skip to content
This repository was archived by the owner on Jul 17, 2025. It is now read-only.

Commit e99f598

Browse files
committed
update doc
1 parent 5bb9c87 commit e99f598

File tree

5 files changed

+57
-73
lines changed

5 files changed

+57
-73
lines changed

data/doc/3.basic_config.md

Lines changed: 10 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -59,69 +59,18 @@ _Example:_
5959

6060
## Widget item
6161

62-
```json
63-
{
64-
"widgets": {
65-
"type": "array",
66-
"items": {
67-
"type": "object",
68-
"properties": {
69-
"name": {
70-
"type": "string"
71-
},
72-
"edge": {
73-
"type": "string",
74-
"enum": ["top", "bottom", "left", "right"]
75-
},
76-
"position": {
77-
"type": "string",
78-
"enum": ["", "top", "bottom", "left", "right", "center"]
79-
},
80-
"layer": {
81-
"type": "string",
82-
"enum": ["top", "bottom", "background", "overlay"]
83-
},
84-
"margins": {
85-
"type": "object",
86-
"properties": {
87-
"top": {
88-
"$ref": "#/definitions/numOrPercentage"
89-
},
90-
"bottom": {
91-
"$ref": "#/definitions/numOrPercentage"
92-
},
93-
"left": {
94-
"$ref": "#/definitions/numOrPercentage"
95-
},
96-
"right": {
97-
"$ref": "#/definitions/numOrPercentage"
98-
}
99-
}
100-
},
101-
"monitor": {
102-
"type": ["integer", "string"],
103-
"default": 0
104-
},
105-
"widget": {
106-
"$ref": "#/definitions/AllWidgets"
107-
}
108-
}
109-
}
110-
}
111-
}
112-
```
113-
11462
Array of widget items. If multiple widgets pile up, the last one in array gets to be on the top.
11563

116-
| Name | Description |
117-
| -------- | ----------------------------------------------------------------------- |
118-
| name | Name of the widget, needed with `togglepin` |
119-
| edge | Edge of the screen, `top/bottom/left/right` |
120-
| position | Ancher of the edge, `top/bottom \|\| left/right` |
121-
| layer | Layer of the shell (window), `top/bottom/background/overlay` |
122-
| margins | Support relative number ("24%"), `top/bottom/left/right` |
123-
| monitor | Monitor index, or the connector name of the monitor, index start from 0 |
124-
| widget | the actual widget, goto `widgets` |
64+
| Name | Description |
65+
| --------------- | ----------------------------------------------------------------------- |
66+
| name | Name of the widget, needed with `togglepin` |
67+
| edge | Edge of the screen, `top/bottom/left/right` |
68+
| position | Ancher of the edge, `top/bottom \|\| left/right` |
69+
| layer | Layer of the shell (window), `top/bottom/background/overlay` |
70+
| margins | Support relative number ("24%"), `top/bottom/left/right` |
71+
| monitor | Monitor index, or the connector name of the monitor, index start from 0 |
72+
| ignore_exlusive | whether to overlap with other layershell. |
73+
| widget | the actual widget, goto `widgets` |
12574

12675
_Example:_
12776

data/doc/4.widgets/0.button.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ _Example:_
1414
"layer": "overlay",
1515
"widget": {
1616
"type": "btn",
17-
"width": 15,
18-
"height": "25%",
17+
"thickness": 15,
18+
"length": "25%",
1919
"frame_rate": 90,
2020
"transition_duration": 150,
2121
"extra_trigger_size": 5,
@@ -35,15 +35,15 @@ _`*` means required property_.
3535
const `btn`
3636
```
3737

38-
## `width*`
38+
## `thickness*`
3939

4040
**\*Thickness\*** of the button, from screen edge to the screen center.
4141

4242
Support relative value, **_but don't recommend using relative value for this property_**.
4343

4444
_Type: `int | string`_
4545

46-
## `height*`
46+
## `length*`
4747

4848
Length of the button.
4949

data/doc/4.widgets/1.slide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ _Example:_
1111
"edge": "top",
1212
"widget": {
1313
"type": "slide",
14-
"width": 20,
15-
"height": 400,
14+
"thickness": 20,
15+
"length": 400,
1616
"transition_duration": 100,
1717
"frame_rate": 120,
1818
"bg_color": "#0D47A1",
@@ -30,17 +30,17 @@ _Example:_
3030
const `slide`
3131
```
3232

33-
## `width*`
33+
## `thickness*`
3434

35-
**\*Thickness\*** of the button, from screen edge to the screen center.
35+
**\*Thickness\*** of the widget, from screen edge to the screen center.
3636

3737
Support relative value, **_but don't recommend using relative value for this property_**.
3838

3939
_Type: `int | string`_
4040

41-
## `height*`
41+
## `length*`
4242

43-
Length of the button.
43+
Length of the widget.
4444

4545
Support relative value.
4646

data/doc/4.widgets/5.box/0.ring.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,44 @@ _Default: `5`_
6868

6969
Text on the left side of the ring.
7070

71+
Currently supported template:
72+
73+
- `{float:precision,multiply}`
74+
- precision: `round()` of a float number, Default `2`
75+
- multiply: the float number will be multiplied by this number, this happens before `precision`. Default 1.
76+
- `{preset}`, preset content if ur using any `preset`, which means it will be an empty string if u use `custom`.
77+
7178
_Type: `null | string`_
7279
_Default: `null`_
7380

81+
## `prefix_hide`
82+
83+
Show only when mouse hover.
84+
85+
_Type: `bool`_
86+
_Default: `false`_
87+
88+
## `suffix`
89+
90+
Text on the right side of the ring.
91+
92+
Currently supported template:
93+
94+
- `{float:precision,multiply}`
95+
- precision: `round()` of a float number, Default `2`
96+
- multiply: the float number will be multiplied by this number, this happens before `precision`. Default 1.
97+
- `{preset}`, preset content if ur using any `preset`, which means it will be an empty string if u use `custom`.
98+
99+
_Type: `null | string`_
100+
_Default: `null`_
101+
102+
## `suffix_hide`
103+
104+
Show only when mouse hover.
105+
106+
_Type: `bool`_
107+
_Default: `false`_
108+
74109
## `font_family`
75110

76111
Font family of all text within ring widget.

data/doc/4.widgets/6.hyprland-workspace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818
const `hyprland-workspace`
1919
```
2020

21-
## `thickness`
21+
## `thickness*`
2222

2323
Equivalent to the old `width`, thickness of the hyprland workspace bar.
2424
Support relative values(string "xx%").
2525

2626
_Type: `int | string`_
2727
_Default: `10`_
2828

29-
## `length`
29+
## `length*`
3030

3131
Equivalent to the old `height`, length of the hyprland workspace bar.
3232
Support relative values(string "xx%").

0 commit comments

Comments
 (0)