1yambar-modules-xkb(5)         File Formats Manual        yambar-modules-xkb(5)
2
3
4

NAME

6       xkb - This module monitors the currently active XKB keyboard layout
7

DESCRIPTION

9       This module monitors the currently active XKB keyboard layout and lock-
10       key states.
11
12       Note: this module is X11 only. It does not work in Wayland.
13

TAGS

15       ┌────────────┬────────┬────────────────────────────────────────────────┐
16       │Name        │ Type   │ Description                                    │
17       ├────────────┼────────┼────────────────────────────────────────────────┤
18       │name        │ string │ Name of currently selected layout, long ver‐   │
19       │            │        │ sion (e.g. "English (US)")                     │
20       ├────────────┼────────┼────────────────────────────────────────────────┤
21       │symbol      │ string │ Name of currently selected layout, short ver‐  │
22       │            │        │ sion (e.g. "us")                               │
23       ├────────────┼────────┼────────────────────────────────────────────────┤
24       │caps_lock   │ bool   │ True if CapsLock is enabled                    │
25       ├────────────┼────────┼────────────────────────────────────────────────┤
26       │num_lock    │ bool   │ True if NumLock is enabled                     │
27       ├────────────┼────────┼────────────────────────────────────────────────┤
28       │scroll_lock │ bool   │ True if ScrollLock is enabled                  │
29       └────────────┴────────┴────────────────────────────────────────────────┘
30

CONFIGURATION

32       No additional attributes supported, only the generic ones (see GENERIC
33       CONFIGURATION in yambar-modules(5))
34

EXAMPLES

36           bar:
37             left:
38               - xkb:
39                   content:
40                     string: {text: "{symbol}"}
41

SEE ALSO

43       yambar-modules-sway-xkb(5), yambar-modules(5), yambar-particles(5),
44       yambar-tags(5), yambar-decorations(5)
45
46                                  2023-07-22             yambar-modules-xkb(5)
Impressum