.\" 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-niri-workspaces" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - niri workspaces module
.PP
.SH DESCRIPTION
.PP
The \fBworkspaces\fR module displays the currently used workspaces in niri.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBniri/workspaces\fR
.PP
\fBall-outputs\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to false, workspaces will only be shown on the output they are on.\& If set to true all workspaces will be shown on every output.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {value} 
.br
	The format, how information should be displayed.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the workspace name, index and state, the corresponding icon gets selected.\& See \fBicons\fR.\&
.PP
\fBdisable-click\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to false, you can click to change workspace.\& If set to true this behaviour is disabled.\&
.PP
\fBdisable-markup\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, button label will escape pango markup.\&
.PP
\fBcurrent-only\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, only the active or focused workspace will be shown.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{value}\fR: Name of the workspace, or index for unnamed workspaces,
as defined by niri.\&
.PP
\fB{name}\fR: Name of the workspace for named workspaces.\&
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
\fB{index}\fR: Index of the workspace on its output.\&
.PP
\fB{output}\fR: Output where the workspace is located.\&
.PP
.SH ICONS
.PP
Additional 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 matches are found.\&
.IP \(bu 4
\fBfocused\fR: Will be shown, when workspace is focused.\&
.IP \(bu 4
\fBactive\fR: Will be shown, when workspace is active on its output.\&
.PD
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"niri/workspaces": {
	"format": "{icon}",
	"format-icons": {
		// Named workspaces
		// (you need to configure them in niri)
		"browser": "",
		"discord": "",
		"chat": "<b></b>",

		// Icons by state
		"active": "",
		"default": ""
	}
}
.fi
.RE
.PP
.SH Style
.PP
.PD 0
.IP \(bu 4
\fB#workspaces button\fR
.IP \(bu 4
\fB#workspaces button.\&focused\fR: The single focused workspace.\&
.IP \(bu 4
\fB#workspaces button.\&active\fR: The workspace is active (visible) on its output.\&
.IP \(bu 4
\fB#workspaces button.\&empty\fR: The workspace is empty.\&
.IP \(bu 4
\fB#workspaces button.\&current_output\fR: The workspace is from the same output as
the bar that it is displayed on.\&
.IP \(bu 4
\fB#workspaces button#niri-workspace-<name>\fR: Workspaces named this, or index
for unnamed workspaces.\&