Module: River

• Mode
• Tags
• Window

---

Mode

The mode module displays current mapping mode of river.

Config

Addressed by river/mode

option	typeof	default	description
format	string	{}	The format, how information should be displayed. On {} data gets inserted.
rotate	integer		Positive value to rotate the text label.
max-length	integer		The maximum length in character the module should display.
on-click	string		Command to execute when clicked on the module.
on-click-right	string		Command to execute when you right clicked on the module.
on-scroll-up	string		Command to execute when scrolling up on the module.
on-scroll-down	string		Command to execute when scrolling down on the module.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.

Example:

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

Style

• #mode
• #mode.<mode>

---

Tags

The tags module displays the current tag state of river.

Config

Addressed by river/tags

option	typeof	default	description
num-tags	integer	9	The number of tags that should be displayed. Max 32.
tag-labels	array		The label to display for each tag.
disable-click	bool	false	If set to false, you can left click to set focused tag. Right click to toggle tag focus. If set to true this behaviour is disabled.

Example:

"river/tags": {
    "num-tags": 5
}

Style

• #tags button
• #tags button.occupied
• #tags button.focused
• #tags button.urgent

Note that occupied/focused/urgent status may overlap. That is, a tag may be both occupied and focused at the same time.

---

Window

The window module displays the title of the currently focused window of river.

Config

Addressed by river/window

option	typeof	default	description
format	string	{}	The format, how information should be displayed. On {} data gets inserted.
rotate	integer		Positive value to rotate the text label.
max-length	integer		The maximum length in character the module should display.
on-click	string		Command to execute when clicked on the module.
on-click-right	string		Command to execute when you right clicked on the module.
on-scroll-up	string		Command to execute when scrolling up on the module.
on-scroll-down	string		Command to execute when scrolling down on the module.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.
tooltip	bool	true	Option to disable tooltip on hover.

Example:

"river/window": {
    "format": "{}"
}

Style

• #window
• #window.focused

The .focused class is applied when the same output as the bar's is focused. This can be used to create an output focus indicator.