Skip to content

keyboard_layout

Shows the current keyboard layout indicator from the active XKB state.

Left-click cycles layouts using the compositor backend when supported. Bind left to an exec action to run a custom command instead - see Widget Actions.

SettingTypeDefaultDescription
hide_when_single_layoutboolfalseHide the widget unless more than one keyboard layout is configured
show_glyphbooltrueShow the keyboard glyph or custom image
glyphstring"keyboard"Bar glyph name: Noctalia alias, Tabler glyph name, or U+ / 0x codepoint. Shown only when show_glyph = true
custom_imagestring""Path to a custom image displayed instead of the glyph. Shown only when show_glyph = true
custom_image_colorizeboolfalseWhen true, tint the custom image with the widget glyph color
show_labelbooltrueShow the layout text label next to the keyboard glyph
displaystring"short""short" = compact code; "full" = full layout name. Ignored when show_label = false. Also used by the keyboard-layout OSD and lockscreen indicator.
custom_labelstable{}Exact layout-name to label overrides. Matching labels override display; unmatched layouts still use short or full. Shared with the keyboard-layout OSD and lockscreen indicator.

At least one of show_glyph or show_label must be true.

[widget.keyboard_layout]
hide_when_single_layout = false
show_glyph = true
show_label = true
display = "short" # short | full
[widget.keyboard_layout.custom_labels]
"German (Neo 2)" = "Neo2"
"English (US)" = "EN"