Install Now
waybar - inhibitor module
Contents
Configuration
what:
typeof: string or array
The inhibitor lock or locks that should be taken when active. The available inhibitor locks are
idle, shutdown, sleep, handle-power-key, handle-suspend-key, handle-hibernate-key and handle-lid-switch.
format:
typeof: string
The format, how the state should be displayed.
format-icons:
typeof: array
Based on the current state, the corresponding icon gets selected.
rotate:
typeof: integer
Positive value to rotate the text label (in 90 degree increments).
max-length:
typeof: integer
The maximum length in character the module should display.
min-length:
typeof: integer
The minimum length in characters the module should accept.
align:
typeof: float
The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the
module is rotated, it will follow the flow of the text.
justify:
typeof: string
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center'
to define the positioning.
on-click:
typeof: string
Command to execute when clicked on the module. A click also toggles the state
on-click-middle:
typeof: string
Command to execute when middle-clicked on the module using mousewheel.
on-click-right:
typeof: string
Command to execute when you right-click on the module.
on-update:
typeof: string
Command to execute when the module is updated.
on-scroll-up:
typeof: string
Command to execute when scrolling up on the module.
on-scroll-down:
typeof: string
Command to execute when scrolling down on the module.
smooth-scrolling-threshold:
typeof: double
Threshold to be used when scrolling.
tooltip:
typeof: bool
default: true
Option to disable tooltip on hover.
menu:
typeof: string
Action that popups the menu. Cannot be "on-click".
menu-file:
typeof: string
Location of the menu descriptor file. There need to be an element of type
GtkMenu with id menumenu-actions:
typeof: array
The actions corresponding to the buttons of the menu.
expand:
typeof: bool
default: false
Enables this module to consume all left over space dynamically.
Description
The inhibitor module allows one to take an inhibitor lock that logind provides. See systemd-inhibit(1)
for more information.
Examples
"inhibitor": {
"what": "handle-lid-switch",
"format": "{icon}",
"format-icons": {
"activated": "",
"deactivated": ""
}
}
2025-02-21 waybar-inhibitor(5)
Format Replacements
{status}: status (activated or deactivated)
{icon}: Icon, as defined in format-icons
Name
waybar - inhibitor module
PNG Icons
