Skip to content
Will edited this page Dec 18, 2024 · 8 revisions

The backlight module displays the current backlight level.

Config

Addressed by backlight

option typeof default description
interval integer 2 The interval in which the information gets polled.
format string {percent}% The format, how information should be displayed. On {} data gets inserted.
format-icons array Based on the current screen brightness, the corresponding icon gets selected.
The order is low to high.
max-length integer The maximum length in characters the module should display.
rotate integer Positive value to rotate the text label.
states array A number of backlight states which get activated on certain brightness levels.
See States
on-click string Command to execute when clicked on the module.
on-click-middle string Command to execute when you middle clicked on the module using mousewheel.
on-click-right string Command to execute when you right click on the module.
on-scroll-up string Command to execute when scrolling up on the module. This replaces the default behaviour of brightness control.
on-scroll-down string Command to execute when scrolling down on the module. This replaces the default behaviour of brightness control.
smooth-scrolling-threshold double Threshold to be used when scrolling.
reverse-scrolling bool false Option to reverse the scroll direction for devices other than a mouse (touchpad, trackpad, etc)
reverse-mouse-scrolling bool false Option to reverse the scroll direction for mice
scroll-step float 1.0 The speed in which to change the brightness when scrolling.
tooltip bool true Option to disable tooltip on hover.
tooltip-format string Text to be displayed in the tooltip

Format replacements:

string replacement
{percent} Screen brightness in percentage
{icon} Icon, as defined in format-icons.

Example:

"backlight": {
    "device": "intel_backlight",
    "format": "{percent}% {icon}",
    "format-icons": ["", ""]
}

Style

  • #backlight

See also

Clone this wiki locally