variables: add the general:snap subcategory (#814)

Moved the callout section regarding subcategories, as this is now
the first subcategory that users will see when scrolling down the page.
This commit is contained in:
Mike Will 2024-10-21 11:08:31 -04:00 committed by GitHub
parent 4d58df5983
commit 366ee7c2a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -72,6 +72,36 @@ SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5
| allow_tearing | master switch for allowing tearing to occur. See [the Tearing page](../Tearing). | bool | false | | allow_tearing | master switch for allowing tearing to occur. See [the Tearing page](../Tearing). | bool | false |
| resize_corner | force floating windows to use a specific corner when being resized (1-4 going clockwise from top left, 0 to disable) | int | 0 | | resize_corner | force floating windows to use a specific corner when being resized (1-4 going clockwise from top left, 0 to disable) | int | 0 |
#### Snap
_Subcategory `general:snap:`_
| name | description | type | default |
| --- | --- | --- | --- |
| enabled | enable snapping for floating windows | bool | false |
| window_gap | minimum gap in pixels between windows before snapping | int | 10 |
| monitor_gap | minimum gap in pixels between window and monitor edges before snapping | int | 10 |
{{< callout type=important >}}
A subcategory is a nested category:
```ini
general {
# ...
# ...
snap {
# ...
# ...
}
}
```
Doing `general:snap {` is **invalid**!
{{< /callout >}}
### Decoration ### Decoration
| name | description | type | default | | name | description | type | default |
@ -115,26 +145,6 @@ _Subcategory `decoration:blur:`_
| popups | whether to blur popups (e.g. right-click menus) | bool | false | | popups | whether to blur popups (e.g. right-click menus) | bool | false |
| popups_ignorealpha | works like ignorealpha in layer rules. If pixel opacity is below set value, will not blur. [0.0 - 1.0] | float | 0.2 | | popups_ignorealpha | works like ignorealpha in layer rules. If pixel opacity is below set value, will not blur. [0.0 - 1.0] | float | 0.2 |
{{< callout type=important >}}
A subcategory is a nested category:
```ini
decoration {
# ...
# ...
blur {
# ...
# ...
}
}
```
Doing `decoration:blur {` is **invalid**!
{{< /callout >}}
{{< callout type=info >}} {{< callout type=info >}}
`blur:size` and `blur:passes` have to be at least 1. `blur:size` and `blur:passes` have to be at least 1.