Workspaces

A bar on every monitor listing that monitor’s workspaces, on every supported compositor. The active workspace is a wide pill, occupied ones are brighter, a click focuses one and the wheel steps through them. On Hyprland, special workspaces get their own toggles.

-- The workspaces of one output, `nil` until the compositor answers.
local function output_of(workspaces, name)
    for _, output in ipairs(workspaces and workspaces.outputs or {}) do
        if output.name == name then
            return output
        end
    end
end

local function focus_step(name, step)
    local output = output_of(mantle.workspaces:get(), name)
    if output == nil then
        return
    end
    for index, workspace in ipairs(output.workspaces) do
        if workspace.id == output.active_workspace then
            local target = output.workspaces[math.max(1, math.min(#output.workspaces, index + step))]
            if target then
                mantle.workspaces:focus(target.id)
            end
            return
        end
    end
end

local function strip(name)
    local wheel = 0 -- partial notches from a touchpad or high-resolution wheel
    return rect {
        align_v = "center",
        -- Wheel up is positive; step towards lower numbers, once per whole notch.
        on_wheel = function(_, steps)
            wheel = wheel + steps
            local notches = math.modf(wheel) -- whole notches; the fraction carries over
            if notches == 0 then return end
            wheel = wheel - notches
            focus_step(name, -math.tointeger(notches))
        end,
        children = {
            list {
                direction = "horizontal",
                spacing = 4,
                align_v = "center",
                items = mantle.workspaces:map(function(workspaces)
                    local output = output_of(workspaces, name)
                    local items = {}
                    for index, workspace in ipairs(output and output.workspaces or {}) do
                        items[index] = {
                            id = workspace.id,
                            label = tostring(workspace.number or workspace.name), -- draw number, send id
                            active = workspace.id == output.active_workspace,
                            populated = workspace.populated,
                        }
                    end
                    return items
                end),
                key = function(item) return tostring(item.id) end,
                each = function(item)
                    return rect {
                        width = item.active and 36 or 22,
                        height = 20,
                        radius = 10,
                        background = item.active and "#89b4fa" or (item.populated and "#45475a" or "#313244"),
                        animate = { width = { duration = 180, easing = "out_cubic" }, background = 180 },
                        on_click = function() mantle.workspaces:focus(item.id) end,
                        children = {
                            text {
                                content = item.label,
                                align_h = "center",
                                align_v = "center",
                                font_size = 11,
                                foreground = item.active and "#1e1e2e" or "#cdd6f4",
                            },
                        },
                    }
                end,
            },
        },
    }
end

-- Hyprland's scratchpads; `special` is nil on niri, so this list is empty there.
local specials = list {
    direction = "horizontal",
    spacing = 4,
    align_v = "center",
    items = mantle.workspaces:map(function(workspaces)
        return workspaces.special
    end),
    key = function(special) return special.name end,
    each = function(special)
        local short = special.name:gsub("^special:?", "") -- "special:scratch" -> "scratch"
        return rect {
            padding = { left = 8, right = 8, top = 2, bottom = 2 },
            radius = 10,
            background = special.shown_on and "#f9e2af" or "#313244",
            on_click = function() mantle.workspaces:toggle_special(special.name) end,
            children = {
                text {
                    content = short ~= "" and short or "special",
                    font_size = 11,
                    foreground = special.shown_on and "#1e1e2e" or "#cdd6f4",
                },
            },
        }
    end,
}

return {
    panel {
        id = "bar",
        layer = "top",
        anchor = { top = true, left = true, right = true },
        width = "fill",
        height = 32,
        exclusive_zone = true,
        child = function(output) -- one instance per monitor, named by connector
            return row {
                width = "fill",
                height = "fill",
                spacing = 12,
                padding = { left = 8, right = 8 },
                background = "#1e1e2e",
                children = { strip(output), specials },
            }
        end,
    },
}

How it works

• child = function(output) builds one bar per monitor and passes its connector name (per-output child).
• outputs[].name matches that connector; active_workspace is the id shown there (workspaces).
• The list rebuilds its buttons from the mapped array, and key keeps each button’s tweens when workspaces come and go (list).
• Labels draw number (or name) and clicks send id: ids are opaque strings (workspaces gotchas).
• on_wheel on the outer rect reads the live state with :get() inside the handler (pointer).
• The width tween makes the active pill grow in place (animation).

Variations