1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-04-19 19:34:24 +02:00
ironbar/docs/modules/Workspaces.md

3.3 KiB

This module is currently only supported on Sway and Hyprland

Shows all current workspaces. Clicking a workspace changes focus to it.

Screenshot showing workspaces widget using custom icons with browser workspace focused

Configuration

Type: workspaces

Name Type Default Description
name_map Map<string, string or image> {} A map of actual workspace names to their display labels/images. Workspaces use their actual name if not present in the map. See here for information on images.
icon_size integer 32 Size to render icon at (image icons only).
all_monitors boolean false Whether to display workspaces from all monitors. When false, only shows workspaces on the current monitor.
sort 'added' or 'alphanumeric' alphanumeric The method used for sorting workspaces. added always appends to the end, alphanumeric sorts by number/name.
JSON
{
  "end": [
    {
      "type": "workspaces",
      "name_map": {
        "1": "",
        "2": "",
        "3": ""
      },
      "all_monitors": false
    }
  ]
}
TOML
[[end]]
type = "workspaces"
all_monitors = false

[[end.name_map]]
1 = ""
2 = ""
3 = ""

YAML
end:
  - type: "workspaces"
    name_map:
      1: ""
      2: ""
      3: ""
    all_monitors: false
Corn
{
    end = [
        {
            type = "workspaces",
            name_map.1 = ""
            name_map.2 = ""
            name_map.3 = ""
            all_monitors = false
        }
    ]
}

Styling

Selector Description
.workspaces Workspaces widget box
.workspaces .item Workspace button
.workspaces .item.focused Workspace button (workspace focused)
.workspaces .item .icon Workspace button icon (any type)
.workspaces .item .text-icon Workspace button icon (textual only)
.workspaces .item .image Workspace button icon (image only)

For more information on styling, please see the styling guide.