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

NAME

6       sway-xkb - This module monitor input devices' active XKB layout
7

DESCRIPTION

9       This module uses Sway extensions to the I3 IPC API to monitor input de‐
10       vices' active XKB layout. As such, it requires Sway to be running.
11
12       Note that the content configuration option is a template; sway-xkb will
13       instantiate a particle list, where each item is instantiated from this
14       template, and represents an input device.
15

TAGS

17       ┌───────┬────────┬─────────────────────────────────────────────────────┐
18Name   Type   Description                                         
19       ├───────┼────────┼─────────────────────────────────────────────────────┤
20       │id     │ string │ Input device identifier                             │
21       ├───────┼────────┼─────────────────────────────────────────────────────┤
22       │layout │ string │ The input device's currently active XKB layout      │
23       └───────┴────────┴─────────────────────────────────────────────────────┘
24

CONFIGURATION

26       ┌──────────────┬─────────────────┬─────┬───────────────────────────────┐
27Name          Type            Req Description                   
28       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
29       │identifiers   │ list of strings │ yes │ Identifiers of input devices  │
30       │              │                 │     │ to monitor. Use swaymsg -t
31       │              │                 │     │ get_inputs to see available   │
32       │              │                 │     │ devices.                      │
33       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
34       │content       │ particle        │ yes │ A particle template; each ex‐ │
35       │              │                 │     │ isting input device will be   │
36       │              │                 │     │ instantiated with this tem‐   │
37       │              │                 │     │ plate.                        │
38       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
39       │left-spacing  │ int             │ no  │ Space, in pixels, in the left │
40       │              │                 │     │ side of each rendered input   │
41       │              │                 │     │ device                        │
42       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
43       │right-spacing │ int             │ no  │ Space, in pixels, on the      │
44       │              │                 │     │ right side of each rendered   │
45       │              │                 │     │ input device                  │
46       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
47       │spacing       │ int             │ no  │ Short-hand for setting both   │
48       │              │                 │     │ left-spacing and right-spac‐
49       │              │                 │     │ ing
50       └──────────────┴─────────────────┴─────┴───────────────────────────────┘
51

EXAMPLES

53           bar:
54             left:
55               - sway-xkb:
56                   identifiers:
57                     - 1523:7:HID_05f3:0007
58                     - 7247:2:USB_USB_Keykoard
59                   spacing: 5
60                   content: {string: {text: "{id}: {layout}"}}
61

SEE ALSO

63       yambar-modules-xkb(5), yambar-modules(5), yambar-particles(5), yambar-
64       tags(5), yambar-decorations(5)
65
66                                  2023-07-22        yambar-modules-sway-xkb(5)
Impressum