waybar/man/waybar-sway-mode.5.scd

81 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

2019-08-26 18:55:20 +02:00
waybar-sway-mode(5)
# NAME
waybar - sway mode module
# DESCRIPTION
The *mode* module displays the current binding mode of Sway
# CONFIGURATION
Addressed by *sway/mode*
*format*: ++
typeof: string ++
default: {} ++
The format, how information should be displayed. On {} data gets inserted.
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label.
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
2021-02-01 17:34:51 +01:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
*align*: ++
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
2019-08-26 18:55:20 +02:00
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module.
2019-12-29 05:22:36 +01:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 18:55:20 +02:00
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
2020-04-12 18:35:41 +02:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 18:55:20 +02:00
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.
*on-scroll-down*: ++
typeof: string ++
Command to execute when scrolling down on the module.
*smooth-scrolling-threshold*: ++
typeof: double ++
Threshold to be used when scrolling.
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
# EXAMPLES
```
2022-01-29 20:19:53 +01:00
"sway/mode": {
2019-08-26 18:55:20 +02:00
"format": " {}",
"max-length": 50
}
```
# STYLE
- *#mode*