yambar-modules-river(5)

📦
version 1.11.0 · 12 versions
, in opensuse-leap 16.0

🌈 NAME 🌈

yambar-modules-river(5) says hi from the File Formats Manual, bestie! 💖

river — This module provides information about the river tags.

🦋 DESCRIPTION 🦋

Okay so this module uses river's status protocol to provide information about the river tags. River is https://github.com/ifreund/river, a dynamic tiling Wayland compositor — iconic, honestly. 🫶

It has an interface similar to the i3/sway module.

The configuration for the river module specifies one title particle, which will be instantiated once for each seat, with tags representing the seats' name, the title of the seats' currently focused view, and its current river "mode".

It also specifies a content template particle, which is instantiated once for all 32 river tags. This means you probably want to use a map particle to hide unused river tags. No cap, that's the move. 💅

🌸 TAGS (for the content particle) 🌸

Here's every tag you get in the content particle, bestie — all facts, zero missing pieces:

  • id (int) — River tag number.
  • urgent (bool) — True if the river tag has at least one urgent view.
  • visible (bool) — True if the river tag is focused by at least one output (i.e. visible on at least one monitor).
  • focused (bool) — True if the river tag is visible and has keyboard focus.
  • occupied (bool) — True if the river tag has views (i.e. windows).
  • state (string) — Set to urgent if urgent is true, focused if focused is true, unfocused if visible is true, but focused is false, or invisible if the river tag is not visible on any monitors.

🎀 TAGS (for the title particle) 🎀

And these are the tags for the title particle — literally the seat-and-title vibe check:

  • seat (string) — The name of the seat.
  • title (string) — The seat's focused view's title.
  • mode (string) — The seat's current mode (entered with e.g. riverctl enter-mode foobar).
  • layout (string) — Current layout of the output currently focused by the seat.

🧚 CONFIGURATION 🧚

This is the config checklist, bestie — title is optional, content is required, and all-monitors has a default you should know about:

  • title (particle, req: no) — Particle that will be instantiated with the seat and title tags.
  • content (particle, req: yes) — Template particle that will be instantiated once for all of the 32 river tags.
  • all-monitors (bool, req: no) — When set to false (the default), tags reflect river tags and seats for the monitor yambar is on only. When set to true, tags reflect the union of all monitors.
Important vibe check: content is required, and all-monitors defaults to false. Don't forget it! 🫶

✨ EXAMPLES ✨

This example is literally the config from the page — copy it exactly, no improvising:

           bar:
             left:
               - river:
                   title: {string: { text: "{seat} - {title} ({layout}/{mode})" }}
                   content:
                     map:
                       conditions:
                         ~occupied: {empty: {}}
                         occupied:
                           string:
                             margin: 5
                             text: "{id}: {state}"

💜 SEE ALSO 💜

Go read these next, bestie — they're giving essential lore:

xoxo, your Unix bestie 💖 — this was yambar-modules-river(5) from the File Formats Manual, dated 2024-04-22. Mwah! 🎀

📦 where this page comes from