.\" 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-sway-scratchpad" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - sway scratchpad module
.PP
.SH DESCRIPTION
.PP
The \fBscratchpad\fR module displays the scratchpad status in Sway
.PP
.SH CONFIGURATION
.PP
Addressed by \fBsway/scratchpad\fR
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {icon} {count} 
.br
	The format, how information should be displayed.\&
.PP
\fBshow-empty\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	Option to show module when scratchpad is empty.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array/object 
.br
	Based on the current scratchpad window counts, the corresponding icon gets selected.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: {app}: {title} 
.br
	The format, how information in the tooltip should be displayed.\&
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
\fB{count}\fR: Number of windows in the scratchpad.\&
.PP
\fB{app}\fR: Name of the application in the scratchpad.\&
.PP
\fB{title}\fR: Title of the application in the scratchpad.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"sway/scratchpad": {
	"format": "{icon} {count}",
	"show-empty": false,
	"format-icons": ["", ""],
	"tooltip": true,
	"tooltip-format": "{app}: {title}"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#scratchpad\fR
.IP \(bu 4
\fB#scratchpad.\&empty\fR