.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar-modules-sway-xkb" "5" "2024-04-20"
.PP
.SH NAME
sway-xkb - This module monitor input devices'\& active XKB layout
.PP
.SH DESCRIPTION
.PP
This module uses \fBSway\fR extensions to the I3 IPC API to monitor input
devices'\& active XKB layout.\& As such, it requires Sway to be running.\&
.PP
\fBNote\fR that the \fIcontent\fR configuration option is a \fBtemplate\fR;
\fBsway-xkb\fR will instantiate a particle list, where each item is
instantiated from this template, and represents an input device.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
id
T}	T{
string
T}	T{
Input device identifier
T}
T{
layout
T}	T{
string
T}	T{
The input device'\&s currently active XKB layout
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
identifiers
T}	T{
list of strings
T}	T{
yes
T}	T{
Identifiers of input devices to monitor.\& Use \fIswaymsg -t get_inputs\fR to see available devices.\&
T}
T{
content
T}	T{
particle
T}	T{
yes
T}	T{
A particle template; each existing input device will be instantiated with this template.\&
T}
T{
left-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, in the left side of each rendered input device
T}
T{
right-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, on the right side of each rendered input device
T}
T{
spacing
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting both \fIleft-spacing\fR and \fIright-spacing\fR
T}
.TE
.sp 1
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    - sway-xkb:
        identifiers:
          - 1523:7:HID_05f3:0007
          - 7247:2:USB_USB_Keykoard
        spacing: 5
        content: {string: {text: "{id}: {layout}"}}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar-modules-xkb\fR(5), \fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.PP