.\" Generated by scdoc 1.11.3
.\" 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-wlr-workspaces" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - wlr workspaces module
.PP
.SH DESCRIPTION
.PP
The \fBworkspaces\fR module displays the currently used workspaces in wayland compositor.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBwlr/workspaces\fR
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {name} 
.br
	The format, how information should be displayed.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the workspace name and state, the corresponding icon gets selected.\& See \fBicons\fR.\&
.PP
\fBsort-by-name\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Should workspaces be sorted by name.\&
.PP
\fBsort-by-coordinates\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Should workspaces be sorted by coordinates.\& 
.br
	Note that if both  \fBsort-by-name\fR and \fBsort-by-coordinates\fR are true sort-by name will be first.\& If both are false - sort by id will be performed.\&
.PP
\fBsort-by-number\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, workspace names will be sorted numerically.\& Takes precedence over any other sort-by option.\&
.PP
\fBall-outputs\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to false workspaces group will be shown only in assigned output.\& Otherwise, all workspace groups are shown.\&
.PP
\fBactive-only\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true only active or urgent workspaces will be shown.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{name}\fR: Name of workspace assigned by compositor
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
.SH CLICK ACTIONS
.PP
\fBactivate\fR: Switch to workspace.\&
.PP
\fBclose\fR: Close the workspace.\&
.PP
.SH ICONS
.PP
In addition to workspace name matching, the following \fBformat-icons\fR can be set.\&
.PP
.PD 0
.IP \(bu 4
\fBdefault\fR: Will be shown, when no string match is found.\&
.IP \(bu 4
\fBactive\fR: Will be shown, when workspace is active
.PD
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"wlr/workspaces": {
	"format": "{name}: {icon}",
	"format-icons": {
		"1": "",
		"2": "",
		"3": "",
		"4": "",
		"5": "",
		"active": "",
		"default": ""
	},
	"sort-by-number": true
}
.fi
.RE
.PP
.SH Style
.PP
.PD 0
.IP \(bu 4
\fB#workspaces\fR
.IP \(bu 4
\fB#workspaces button\fR
.IP \(bu 4
\fB#workspaces button.\&active\fR
.IP \(bu 4
\fB#workspaces button.\&urgent\fR
.IP \(bu 4
\fB#workspaces button.\&hidden\fR