waybar-river-mode(5)

πŸ’– waybar-river-mode(5) β€” the river mode module, explained by your unix bestie πŸ’–

okay so bestie, this is a File Formats Manual page for waybar-river-mode, and I'm about to make it make sense for you. sit down, sip your iced whatever, and let's go 🫢


✨ NAME ✨

waybar β€” river mode module. that's it, that's the vibe. it's the module, it lives in waybar, it's about river's modes. periodt.


🌊 DESCRIPTION 🌊

the mode module displays the current mapping mode of river. that's the whole job. it looks at river, sees which mode you're in, and shows it. no cap, that's literally it. πŸ’…


πŸŽ€ CONFIGURATION πŸŽ€

you address this module as river/mode. yes queen, that's the address. put your settings under it and waybar will find them.


  • format β€” typeof: string, default: {}. this is the format, like, how the info should be displayed. the {} is the spot where the data gets inserted. so {} means "just dump the mode here" and anything else around it is ✨ decoration ✨.
  • rotate β€” typeof: integer. a positive value rotates the text label, and it rotates in 90 degree increments. so it's giving 90, 180, 270, that kinda energy. πŸ”„
  • max-length β€” typeof: integer. the maximum length in characters that the module should display. long mode names get cut off, sorry babe.
  • min-length β€” typeof: integer. the minimum length in characters the module should accept.
  • align β€” typeof: float. the alignment of the label within the module. 0 is left-aligned and 1 is right-aligned. and heads up β€” if the module is rotated, it will follow the flow of the text. so the alignment travels with the rotation, iykyk.
  • justify β€” typeof: string. the alignment of the text within the module's label. you can pick 'left', 'right', or 'center' to define the positioning. left, right, or center bestie, that's the whole menu.
  • on-click β€” typeof: string. command to execute when you click on the module.
  • on-click-middle β€” typeof: string. command to execute when you middle-click on the module using the mousewheel.
  • on-click-right β€” typeof: string. command to execute when you right-click on the module.
  • on-update β€” typeof: string. command to execute when the module is updated.
  • on-scroll-up β€” typeof: string. command to execute when you scroll up on the module.
  • on-scroll-down β€” typeof: string. command to execute when you scroll down on the module.
  • smooth-scrolling-threshold β€” typeof: double. threshold to be used when scrolling. it's the "how much scroll counts as a scroll" number πŸ–±οΈ
  • 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 β€” don't skip that part, it's not optional.
  • menu-actions β€” typeof: array. the actions corresponding to the buttons of the menu.
  • expand β€” typeof: bool, default: false. enables this module to consume all left over space dynamically. so it eats the empty space like it's been waiting all day 🍽️

🌈 EXAMPLES 🌈

here's the moment you've been waiting for, bestie. the config:

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

that's the whole thing. format goes in, mode gets shown. slay.


πŸ’… STYLE πŸ’…

the css selectors you can style this module with:

  • #mode
  • #mode.<mode>

so #mode hits the module itself, and #mode.<mode> lets you style per-mode, where <mode> is the actual mode name. iconic behavior fr fr. πŸ”₯


and that's the tea, bestie πŸ’œ this was waybar-river-mode(5) from the File Formats Manual, and this version is dated 2026-02-08. go forth and show your river modes with main character energy πŸ‘‘βœ¨

πŸ“¦ where this page comes from