Skip to content

Commit 1a4a2dc

Browse files
hyprscrolling: add config example in README (#491)
1 parent d0d8e8d commit 1a4a2dc

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

hyprscrolling/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@ Adds a scrolling layout to Hyprland.
88

99
Make sure to set the `general:layout` to `scrolling` to use this layout.
1010

11-
*All config values are in `plugin:hyprscrolling`.*
11+
All config values can be set in your Hyprland config file, for example:
12+
```
13+
plugin {
14+
hyprscrolling {
15+
column_width = 0.7
16+
fullscreen_on_one_column = false
17+
}
18+
}
19+
```
1220

1321
| name | description | type | default |
1422
| -- | -- | -- | -- |
@@ -31,3 +39,13 @@ Make sure to set the `general:layout` to `scrolling` to use this layout.
3139
| promote | moves a window to its own new column | none |
3240
| swapcol | Swaps the current column with its neighbor to the left (`l`) or right (`r`). The swap wraps around (e.g., swapping the first column left moves it to the end). | `l` or `r` |
3341
| movecoltoworkspace | Moves the entire current column to the specified workspace, preserving its internal layout. Works with existing, new, and special workspaces. e.g. like `1`, `2`, `-1`, `+2`, `special`, etc. | workspace identifier|
42+
43+
Example key bindings for your Hyprland config:
44+
```
45+
bind = $mainMod, period, layoutmsg, move +col
46+
bind = $mainMod, comma, layoutmsg, move -col
47+
bind = $mainMod SHIFT, period, layoutmsg, movewindowto r
48+
bind = $mainMod SHIFT, comma, layoutmsg, movewindowto l
49+
bind = $mainMod SHIFT, up, layoutmsg, movewindowto u
50+
bind = $mainMod SHIFT, down, layoutmsg, movewindowto d
51+
```

0 commit comments

Comments
 (0)