---
name: "yambar-modules-xkb"
section: "5"
platform: "linux"
package: "yambar"
version: "1.11.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/yambar-modules-xkb"
---

# yambar-modules-xkb(5)

This module monitors the currently active XKB keyboard layout

## NAME

xkb - This module monitors the currently active XKB keyboard layout

## DESCRIPTION

This module monitors the currently active XKB keyboard layout and lock-key states.

Note: this module is X11 only. It does not work in Wayland.

## TAGS

| | | |
| --- | --- | --- |
| **Name** | **Type** | **Description** |
| name | string | Name of currently selected layout, long version (e.g. "English (US)") |
| symbol | string | Name of currently selected layout, short version (e.g. "us") |
| caps\_lock | bool | True if **CapsLock** is enabled |
| num\_lock | bool | True if **NumLock** is enabled |
| scroll\_lock | bool | True if **ScrollLock** is enabled |

## CONFIGURATION

No additional attributes supported, only the generic ones (see **GENERIC CONFIGURATION** in [**yambar-modules**(5)](/yambar-modules/5.md))

## EXAMPLES

```
bar:
  left:
    - xkb:
        content:
          string: {text: "{symbol}"}
```

## SEE ALSO

[**yambar-modules-sway-xkb**(5)](/yambar-modules-sway-xkb/5.md), [**yambar-modules**(5)](/yambar-modules/5.md), [**yambar-particles**(5)](/yambar-particles/5.md), [**yambar-tags**(5)](/yambar-tags/5.md), [**yambar-decorations**(5)](/yambar-decorations/5.md)