waybar - keyboard-state module

interval: Deprecated, this module uses event loop now, the interval has no effect. typeof: integer default: 1 The interval, in seconds, to poll the keyboard state. format: typeof: string|object default: {name} {icon} The format, how information should be displayed. If a string, the same format is used for all keyboard states. If an object, the fields "numlock", "capslock", and "scrolllock" each specify the format for the corresponding state. Any unspecified states use the default format. format-icons: typeof: object default: {"locked": "locked", "unlocked": "unlocked"} Based on the keyboard state, the corresponding icon gets selected. The same set of icons is used for number, caps, and scroll lock, but the icon is selected from the set independently for each. See icons. numlock: typeof: bool default: false Display the number lock state. capslock: typeof: bool default: false Display the caps lock state. scrolllock: typeof: bool default: false Display the scroll lock state. device-path: typeof: string default: chooses first valid input device Which libevdev input device to show the state of. Libevdev devices can be found in /dev/input. The device should support number lock, caps lock, and scroll lock events. binding-keys: typeof: array default: [58, 69, 70] Customize the key to trigger this module, the key number can be found in /usr/include/linux/input- event-codes.h or running sudo libinput debug-events --show-keycodes. expand: typeof: bool default: false Enables this module to consume all left over space dynamically.

The keyboard-state module displays the state of number lock, caps lock, and scroll lock. You must be a member of the input group to use this module.

"keyboard-state": { "numlock": true, "capslock": true, "format": "{name} {icon}", "format-icons": { "locked": "", "unlocked": "" } }

{name}: Caps, Num, or Scroll. {icon}: Icon, as defined in format-icons.

The following format-icons can be set. • locked: Will be shown when the keyboard state is locked. Default "locked". • unlocked: Will be shown when the keyboard state is not locked. Default "unlocked"

waybar - keyboard-state module

• #keyboard-state • #keyboard-statelabel • #keyboard-statelabel.locked • #keyboard-statelabel.numlock • #keyboard-statelabel.numlock.locked • #keyboard-statelabel.capslock • #keyboard-statelabel.capslock.locked • #keyboard-statelabel.scrolllock • #keyboard-statelabel.scrolllock.locked 2025-02-21 waybar-keyboard-state(5)