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 iden‐ │
21       │       │        │ tifier             │
22       ├───────┼────────┼────────────────────┤
23       │layout │ string │ The input device's │
24       │       │        │ currently active   │
25       │       │        │ XKB layout         │
26       └───────┴────────┴────────────────────┘
27

CONFIGURATION

29       ┌──────────────┬─────────────────┬─────┬──────────────────┐
30Name          Type            Req Description      
31       ├──────────────┼─────────────────┼─────┼──────────────────┤
32       │identifiers   │ list of strings │ yes │ Identifiers of   │
33       │              │                 │     │ input devices to │
34       │              │                 │     │ monitor. Use     │
35       │              │                 │     │ swaymsg -t
36       │              │                 │     │ get_inputs to    │
37       │              │                 │     │ see available    │
38       │              │                 │     │ devices.         │
39       ├──────────────┼─────────────────┼─────┼──────────────────┤
40       │content       │ particle        │ yes │ A particle tem‐  │
41       │              │                 │     │ plate; each ex‐  │
42       │              │                 │     │ isting input de‐ │
43       │              │                 │     │ vice will be in‐ │
44       │              │                 │     │ stantiated with  │
45       │              │                 │     │ this template.   │
46       ├──────────────┼─────────────────┼─────┼──────────────────┤
47       │left-spacing  │ int             │ no  │ Space, in pix‐   │
48       │              │                 │     │ els, in the left │
49       │              │                 │     │ side of each     │
50       │              │                 │     │ rendered input   │
51       │              │                 │     │ device           │
52       ├──────────────┼─────────────────┼─────┼──────────────────┤
53       │right-spacing │ int             │ no  │ Space, in pix‐   │
54       │              │                 │     │ els, on the      │
55       │              │                 │     │ right side of    │
56       │              │                 │     │ each rendered    │
57       │              │                 │     │ input device     │
58       ├──────────────┼─────────────────┼─────┼──────────────────┤
59       │spacing       │ int             │ no  │ Short-hand for   │
60       │              │                 │     │ setting both     │
61       │              │                 │     │ left-spacing and │
62       │              │                 │     │ right-spacing
63       └──────────────┴─────────────────┴─────┴──────────────────┘
64

EXAMPLES

66           bar:
67             left:
68               - sway-xkb:
69                   identifiers:
70                     - 1523:7:HID_05f3:0007
71                     - 7247:2:USB_USB_Keykoard
72                   spacing: 5
73                   content: {string: {text: "{id}: {layout}"}}
74

SEE ALSO

76       yambar-modules-xkb(5), yambar-modules(5), yambar-particles(5), yambar-
77       tags(5), yambar-decorations(5)
78
79                                  2022-08-26        yambar-modules-sway-xkb(5)
Impressum