.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar\-mango\-workspaces" "5" "2026\-11\-05"
.PP
.SH NAME
.PP
waybar \- mango workspaces module
.PP
.SH DESCRIPTION
.PP
The \fBworkspaces\fR module displays the tags (workspaces) of the Mango compositor.\& It shows an overview button when the overview mode is active (active tag is 0), and individual tag buttons otherwise.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBmango/workspaces\fR
.PP
\fBformat\fR: 
.br
typeof: string 
.br
default: {value} 
.br
The format for each tag button.\& See \fBFORMAT REPLACEMENTS\fR.\&
.PP
\fBformat\-icons\fR: 
.br
typeof: object 
.br
Icons to be used instead of the workspace index or name.\& Keys can be a workspace index (as a string), or one of the following special state keys: \fBdefault\fR, \fBactive\fR, \fBurgent\fR, \fBempty\fR.\&
.PP
\fBdisable\-markup\fR: 
.br
typeof: bool 
.br
default: false 
.br
If true, the button label will not be interpreted as Pango markup.\&
.PP
\fBcurrent\-only\fR: 
.br
typeof: bool 
.br
default: false 
.br
If true, only the currently active workspace button is shown.\&
.PP
\fBhide\-empty\fR: 
.br
typeof: bool 
.br
default: false 
.br
If true, buttons for empty (client_count == 0) workspaces are hidden, unless the workspace is active.\&
.PP
\fBtag\-filter\fR: 
.br
typeof: array of uint64, or object of output name to array of uint64 
.br
default: all tags 
.br
Only tags whose indices are included in this list are displayed.\& If omitted
.RS 4
or empty, all tags are displayed.\& If a plain array is given, the same filter
applies regardless of output.\& If an object is given, each key is an output
name (as reported by the compositor) and its value is the list of visible
tag indices for that output; outputs not present as a key are unfiltered.\&
.PP
.RE
\fBon\-click\fR: 
.br
typeof: string 
.br
Command to execute on left click.\& Typically set to \fBactivate\fR or \fBtoggle\fR.\&
.PP
\fBon\-click\-middle\fR: 
.br
typeof: string 
.br
Command for middle click.\& Same actions as \fBon\-click\fR.\&
.PP
\fBon\-click\-right\fR: 
.br
typeof: string 
.br
Command for right click.\& Same actions as \fBon\-click\fR.\&
.PP
\fBoverview\-label\fR: 
.br
typeof: string 
.br
default: "OVERVIEW" 
.br
Label shown on the overview button when the overview is active.\&
.PP
\fBexpand\fR: 
.br
typeof: bool 
.br
default: false 
.br
Enables the module to consume leftover space.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{value}\fR: Workspace index (same as \fB{index}\fR for unnamed workspaces).\&
.PP
\fB{name}\fR: Workspace name (equal to the index for unnamed workspaces in Mango).\&
.PP
\fB{icon}\fR: Icon selected from \fBformat\-icons\fR based on workspace index and state.\&
.PP
\fB{index}\fR: Numeric index of the workspace.\&
.PP
\fB{output}\fR: Name of the output where the workspace is located.\&
.PP
.SH CLICK ACTIONS
.PP
When a tag button is clicked, the action from \fBon\-click\fR (or its middle/right variants) is evaluated.\&
Supported actions:
.PP
.PD 0
.IP \(bu 4
\fBactivate\fR: dispatch view,<index>
.IP \(bu 4
\fBtoggle\fR: dispatch toggleview,<index>
.PD
.PP
When the overview button is clicked, the actions change to:
.PP
.PD 0
.IP \(bu 4
\fBactivate\fR: dispatch overview
.IP \(bu 4
\fBtoggle\fR: dispatch toggleoverview
.PD
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"mango/workspaces": {
	"format": "{icon}",
	"format\-icons": {
		"1": "一",
		"2": "二",
		"active": "",
		"default": "",
		"urgent": "",
		"empty": ""
	},
	"tag\-filter": {
		"DP\-1": [1, 2, 3, 4, 5, 6],
		"DP\-2": [7, 8, 9]
	},
	"on\-click": "activate",
	"on\-click\-right": "toggle",
	"overview\-label": ""
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#workspaces button\fR
.IP \(bu 4
\fB#workspaces button.\&active\fR – the workspace is active (visible) on its output.\&
.IP \(bu 4
\fB#workspaces button.\&urgent\fR – the workspace has at least one urgent window.\&
.IP \(bu 4
\fB#workspaces button.\&empty\fR – the workspace contains no clients.\&
.IP \(bu 4
\fB#workspaces button.\&current_output\fR – the workspace belongs to the output where the bar is shown.\&
.IP \(bu 4
\fB#workspaces button.\&overview\fR – the overview button (visible in overview mode).\&