HyprExpo: update documentation (#405)

This commit is contained in:
Evan Koehler 2025-06-24 23:16:41 +02:00 committed by GitHub
parent aa23323de3
commit c1fdf38bfc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,13 +1,12 @@
# hyprexpo
Overview plugin like gnome kde or wf.
# HyprExpo
HyprExpo is an overview plugin like Gnome, KDE or wf.
![HyprExpo](https://github.com/user-attachments/assets/e89df9d2-9800-4268-9929-239ad9bc3a54)
## Config
A great start to configure this plugin would be adding this code to the `plugin` section of your hyprland configuration file:
```ini
bind = SUPER, grave, hyprexpo:expo, toggle # can be: toggle, select, off/disable or on/enable
# .config/hypr/hyprland.conf
plugin {
hyprexpo {
columns = 3
@ -21,5 +20,40 @@ plugin {
gesture_positive = true # positive = swipe down. Negative = swipe up.
}
}
```
### Properties
| property | type | description | default |
| --- | --- | --- | --- |
columns | number | how many desktops are displayed on one line | `3`
gap_size | number | gap between desktops | `5`
bg_col | color | color in gaps (between desktops) | `rgb(000000)`
workspace_method | [center/first] [workspace] | position of the desktops | `center current`
enable_gesture | boolean | enable touchpad gestures | `true`
gesture_fingers | `3` or `4` | how many fingers are needed in the gesture | `3`
gesture_distance | number | how far is the max | `300`
gesture_positive | boolean | whether to swipe down (true), or up (false) | `true`
### Binding
```bash
# hyprland.conf
bind = MODIFIER, KEY, hyprexpo:expo, OPTION
```
Example:
```bash
# This will toggle HyprExpo when SUPER+g is pressed
bind = SUPER, g, hyprexpo:expo, toggle
```
Here are a list of options you can use:
| option | description |
| --- | --- |
toggle | displays if hidden, hide if displayed
select | selects the hovered desktop
off | hides the overview
disable | same as `off`
on | displays the overview
enable | same as `on`