waybar-wlr-workspaces(5)

💖 waybar-wlr-workspaces — the manual page (5) 💖

okay bestie, so this is the waybar-wlr-workspaces(5) page from the File Formats Manual, and it's literally just the waybar workspaces module but make it make sense. sit down, grab a strawberry, let's go 🍓

---

✨ NAME ✨

waybar — the wlr workspaces module, bestie. it's giving "your workspaces but cute".

---

🌸 DESCRIPTION 🌸

The workspaces module displays the currently used workspaces in wayland compositor. no cap, that's the whole job. it shows you your workspaces. iconic behaviour honestly 👑

---

🎀 CONFIGURATION 🎀

You address this thing by wlr/workspaces. that's the vibe check you gotta pass to get in here.

• format — typeof: string, default: {name}. The format, how information should be displayed. this is the outfit your workspaces are wearing 💅
• format-icons — typeof: array. Based on the workspace name and state, the corresponding icon gets selected. See icons. (yes, that's a lil teaser, scroll down bestie 🫶)
• sort-by-name — typeof: bool, default: true. Should workspaces be sorted by name. alphabetically cute.
• sort-by-coordinates — typeof: bool, default: true. Should workspaces be sorted by coordinates.

Note that if both sort-by-name and sort-by-coordinates are true sort-by name will be first. If both are false — sort by id will be performed. so like, one of them always wins, there's no chaos allowed 😭

• sort-by-number — typeof: bool, default: false. If set to true, workspace names will be sorted numerically. Takes precedence over any other sort-by option. it's the main character of sorting, periodt.
• all-outputs — typeof: bool, default: false. If set to false workspaces group will be shown only in assigned output. Otherwise, all workspace groups are shown. so flip it to true if you want everybody everywhere 🌈
• active-only — typeof: bool, default: false. If set to true only active or urgent workspaces will be shown. minimalism era ✨

---

🦋 FORMAT REPLACEMENTS 🦋

these are the lil placeholders you can drop into your format, and they actually get replaced:

• {name} — Name of workspace assigned by compositor
• {icon} — Icon, as defined in format-icons.

---

💅 CLICK ACTIONS 💅

• activate — Switch to workspace. one click, boom, you're there 🫰
• close — Close the workspace. bye bestie 💀

---

🧚 ICONS 🧚

In addition to workspace name matching, the following format-icons can be set:

• default — Will be shown, when no string match is found.
• active — Will be shown, when workspace is active

so like, name-match it OR use these fallbacks. both? both. 🎀

---

⭐ EXAMPLES ⭐

look at her. she's gorgeous. no notes.

"wlr/workspaces": {
     "format": "{name}: {icon}",
     "format-icons": {
          "1": "",
          "2": "",
          "3": "",
          "4": "",
          "5": "",
          "active": "",
          "default": ""
     },
     "sort-by-number": true
}

---

👑 Style 👑

the CSS hooks you get to play with, go off:

• #workspaces
• #workspaces button
• #workspaces button.active
• #workspaces button.urgent
• #workspaces button.hidden

---

and that's the whole page bestie, you ate it 💖 this was waybar-wlr-workspaces(5) from 2024-04-01, version/source stamped right there in the footer — so if you're reading this way later, hi, time traveller, still valid as of that date 🌸 mwah, go configure something beautiful 🫶✨