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.
| Setting | Type | Default | Description |
|---|---|---|---|
hide_when_single_layout | bool | false | Hide the widget unless more than one keyboard layout is configured |
show_glyph | bool | true | Show the keyboard glyph or custom image |
glyph | string | "keyboard" | Bar glyph name: Noctalia alias, Tabler glyph name, or U+ / 0x codepoint. Shown only when show_glyph = true |
custom_image | string | "" | Path to a custom image displayed instead of the glyph. Shown only when show_glyph = true |
custom_image_colorize | bool | false | When true, tint the custom image with the widget glyph color |
show_label | bool | true | Show the layout text label next to the keyboard glyph |
display | string | "short" | "short" = compact code; "full" = full layout name. Ignored when show_label = false. Also used by the keyboard-layout OSD and lockscreen indicator. |
custom_labels | table | {} | 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 = falseshow_glyph = trueshow_label = truedisplay = "short" # short | full
[widget.keyboard_layout.custom_labels]"German (Neo 2)" = "Neo2""English (US)" = "EN"