Waybar/man/waybar-river-layout.5.scd

85 lines
1.8 KiB
Plaintext
Raw Normal View History

2023-01-31 05:34:38 +00:00
waybar-river-layout(5)
# NAME
waybar - river layout module
# DESCRIPTION
The *layout* module displays the current layout in river.
It may not be set until a layout is first applied.
# CONFIGURATION
Addressed by *river/layout*
*format*: ++
typeof: string ++
default: {} ++
The format, how information should be displayed. On {} data gets inserted.
2023-01-31 05:34:38 +00:00
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label (in 90 degree increments).
2023-01-31 05:34:38 +00:00
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
2023-01-31 05:34:38 +00:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should accept.
2023-01-31 05:34:38 +00:00
*align*: ++
typeof: float ++
2024-03-04 19:00:57 +00:00
The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
*justify*: ++
typeof: string ++
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
2023-01-31 05:34:38 +00:00
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module.
2023-01-31 05:34:38 +00:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2023-01-31 05:34:38 +00:00
*on-click-right*: ++
typeof: string ++
Command to execute when you right-click on the module.
2023-01-31 05:34:38 +00:00
*menu*: ++
typeof: string ++
Action that popups the menu.
*menu-file*: ++
typeof: string ++
Location of the menu descriptor file. There need to be an element of type
GtkMenu with id *menu*
*menu-actions*: ++
typeof: array ++
The actions corresponding to the buttons of the menu.
2023-01-31 05:34:38 +00:00
# EXAMPLE
```
"river/layout": {
"format": "{}",
"min-length": 4,
"align": "right"
2023-01-31 05:34:38 +00:00
}
```
# STYLE
- *#layout*
- *#layout.focused* Applied when the output this module's bar belongs to is focused.
# SEE ALSO
waybar(5), river(1)