waybar-river-mode(5)

# NAME

waybar - river mode module

# DESCRIPTION

The *mode* module displays the current mapping mode of river.

# CONFIGURATION

Addressed by *river/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.

*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.

*on-click*: ++
    typeof: string ++
    Command to execute when clicked on the module.

*on-click-middle*: ++
    typeof: string ++
    Command to execute when middle-clicked on the module using mousewheel.

*on-click-right*: ++
    typeof: string ++
    Command to execute when you right clicked on the module.

*on-update*: ++
    typeof: string ++
    Command to execute when the module is updated.

*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.

# EXAMPLES

```
"river/mode": {
    "format": " {}"
}
```

# STYLE

- *#mode*
- *#mode.<mode>*