hyprland-plugins/hyprbars/README.md

61 lines
1.6 KiB
Markdown
Raw Normal View History

2023-02-28 21:30:51 +01:00
# hyprbars
Adds simple title bars to windows.
![preview](https://i.ibb.co/hLDRCpT/20231029-22h30m05s.png)
2023-03-01 00:21:20 +01:00
2023-02-28 21:30:51 +01:00
## Config
All config options are in `plugin:hyprbars`:
```
plugin {
hyprbars {
2023-10-29 18:33:32 +01:00
# example config
bar_height = 20
# example buttons (R -> L)
# hyprbars-button = color, size, on-click
hyprbars-button = rgb(ff4040), 10, 󰖭, hyprctl dispatch killactive
hyprbars-button = rgb(eeee11), 10, , hyprctl dispatch fullscreen 1
2023-02-28 21:30:51 +01:00
}
}
```
`bar_color` -> (col) bar's background color
2023-02-28 21:31:28 +01:00
2023-12-13 01:46:12 +01:00
`bar_height` -> (int) bar's height (default `15`)
2023-02-28 21:31:28 +01:00
`col.text` -> (col) bar's title text color
2023-02-28 21:31:28 +01:00
`bar_title_enabled` -> (bool) whether to render the title (default `true`)
2023-12-13 01:46:12 +01:00
`bar_text_size` -> (int) bar's title text font size (default `10`)
2023-02-28 21:31:28 +01:00
2023-12-13 01:46:12 +01:00
`bar_text_font` -> (str) bar's title text font (default `Sans`)
`bar_text_align` -> (str) bar's title text alignment (default `center`, can also be `left`)
`bar_buttons_alignment` -> (str) bar's buttons alignment (default: `right`, can also be `left`)
`bar_part_of_window` -> (bool) whether the bar is a part of the main window (if it is, stuff like shadows render around it)
`bar_precedence_over_border` -> (bool) whether the bar should have a higher priority than the border (border will be around the bar)
2023-12-13 02:29:13 +01:00
`bar_padding` -> (int) left / right edge padding (default `7`)
`bar_button_padding` -> (int) padding between the buttons (default `5`)
## Buttons Config
2023-10-29 18:33:32 +01:00
Use the `hyprbars-button` keyword.
2023-10-29 18:33:32 +01:00
```ini
hyprbars-button = color, size, icon, on-click
```
## Window rules
Hyprbars supports the following _dynamic_ window rules:
`plugin:hyprbars:nobar` -> disables the bar on matching windows.