.\" 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\-hyprland\-submap" "5" "2026\-08\-31"
.PP
.SH NAME
.PP
waybar \- hyprland submap module
.PP
.SH DESCRIPTION
.PP
The \fBsubmap\fR module displays the currently active submap similar to \fBsway/mode\fR.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBhyprland/submap\fR
.PP
\fBformat\fR: 
.br
typeof: string 
.br
default: {} 
.br
The format, how information should be displayed.\& On {} the currently active submap is displayed.\&
.PP
\fBrotate\fR: 
.br
typeof: integer 
.br
Positive value to rotate the text label (in 90 degree increments).\&
.PP
\fBmax\-length\fR: 
.br
typeof: integer 
.br
The maximum length in character the module should display.\&
.PP
\fBmin\-length\fR: 
.br
typeof: integer 
.br
The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
typeof: float 
.br
The alignment of the label within the module, where 0 is left\-aligned and 1 is right\-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
typeof: string 
.br
The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon\-click\fR: 
.br
typeof: string 
.br
Command to execute when clicked on the module.\&
.PP
\fBon\-click\-middle\fR: 
.br
typeof: string 
.br
Command to execute when middle\-clicked on the module using mousewheel.\&
.PP
\fBon\-click\-right\fR: 
.br
typeof: string 
.br
Command to execute when you right\-click on the module.\&
.PP
\fBon\-update\fR: 
.br
typeof: string 
.br
Command to execute when the module is updated.\&
.PP
\fBon\-scroll\-up\fR: 
.br
typeof: string 
.br
Command to execute when scrolling up on the module.\&
.PP
\fBon\-scroll\-down\fR: 
.br
typeof: string 
.br
Command to execute when scrolling down on the module.\&
.PP
\fBsmooth\-scrolling\-threshold\fR: 
.br
typeof: double 
.br
Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
typeof: bool 
.br
default: true 
.br
Option to disable tooltip on hover.\&
.PP
\fBalways\-on\fR: 
.br
typeof: bool 
.br
default: false 
.br
Option to display the widget even when there'\&s no active submap.\&
.PP
\fBdefault\-submap\fR 
.br
typeof: string 
.br
default: Default 
.br
Option to set the submap name to display when not in an active submap.\&
.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
\fBexpand\fR: 
.br
typeof: bool 
.br
default: false 
.br
Enables this module to consume all left over space dynamically.\&
.PP
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"hyprland/submap": {
	"format": "✌️ {}",
	"max\-length": 8,
	"tooltip": false
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#submap\fR
.IP \(bu 4
\fB#submap.\&<name>\fR