yambar-modules-i3(5)

💅 yambar-modules-i3 — bestie edition 🌸

okay so this is yambar-modules-i3, from section 5 of the manual (File Formats Manual, if you're keeping score), and no cap it's the glow-up your bar has been waiting for ✨

✨ NAME ✨

i3 — this module monitors i3 and sway workspaces 🪟👑

🦋 DESCRIPTION 🦋

okay so here's the thing that makes this module lowkey different from every other module: normally content is just a single particle, right? but the i3 module's content is an associative array mapping i3/sway workspace names to a particle. it's giving ✨organized chaos✨ but like, the good kind 💖

you can add an empty workspace name, "", as a catch-all workspace particle. the i3 module will fallback to this entry if it cannot find the workspace name in the content map. so it's literally your safety net, your ride-or-die default 🫶

it also recognizes the special name current, which always represents the currently focused workspace. on Sway, this can be used together with the application and title tags to replace the X11-only xwindow module — slay, we love a cross-platform moment 💅

---

🎀 TAGS 🎀

here's the whole tag lineup, no skips, no cuts 🍓

• name — string — the workspace name
• visible — bool — true if the workspace is currently visible (on any output)
• focused — bool — true if the workspace is currently focused
• urgent — bool — true if the workspace has the urgent flag set
• empty — bool — true if the workspace is empty (Sway only)
• state — string — one of urgent, focused, unfocused or invisible (note: unfocused is when it is visible, but neither focused nor urgent)
• application — string — name of application currently focused on this workspace (Sway only — use the xwindow module in i3)
• title — string — this workspace's focused window's title
• mode — string — the name of the current mode

---

🌈 CONFIGURATION 🌈

all the knobs and dials, bestie 🔧

• content — associative array — required ✅ — unlike other modules, content is an associative array mapping workspace names to particles. use "" to specify a default fallback particle, or current for the currently active workspace.
• sort — enum — optional — how to sort the list of workspaces; one of none, native, ascending or descending, defaults to none. use native to sort numbered workspaces only.
• strip-workspace-numbers — bool — optional — if true, N: prefixes will be stripped from workspace names. useful together with sort, to have the workspace order fixed.
• persistent — list of strings — optional — persistent workspaces. i.e. workspaces that are never removed, even if empty. they're immortal fr fr 👑
• left-spacing — int — optional — space, in pixels, on the left-side of each rendered workspace particle
• right-spacing — int — optional — space, in pixels, on the right-side of each rendered workspace particle
• spacing — int — optional — short-hand for setting both left-spacing and right-spacing at once. two birds, one icon 💅

---

⭐ EXAMPLES ⭐

this renders all workspace names, with an * indicating the currently focused one. it also renders the currently focused application name and window title. the way this config eats, honestly 😭🔥

bar:
  left:
    - i3:
        content:
          "":
            map:
              default: {string: {text: "{name}"}}
              conditions:
                state == focused: {string: {text: "{name}*"}}
          current: { string: {text: "{application}: {title}"}}

---

🫶 SEE ALSO 🫶

yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5)

---

and that's the whole page bestie 💜 this one's from the File Formats Manual crowd, dated 2024-04-22, and it's yambar-modules-i3(5) — go forth and make your bar iconic 🧚✨