Skip to content

Brightness

Jump to bottom
Jake Stanger edited this page Feb 10, 2026 · 1 revision

Brightness information about screen or led brightness levels in percent. Allows to change the respective value via scrolling.

Configuration

Type: brightness

Name Type Default Profile? Description
format string {percentage}% Yes Format string to use for the widget button label.
icon_label string null Yes Icon to show alongside the label. Supports image icons.
mode.type systemd or keyboard systemd No The data backend of the brightness module, this can be either the KdbBrightness dbus which is good for keyboard data, or the more general login1 dbus in combination with /sys/class/.
mode.subsystem backlight or leds backlight No The name of the subsystem use on the filesystem.
mode.name string or null null No When set, using the specific directory, within /sys/class/ . If null the module will try to find a reasonable default.
smooth_scroll_speed float 1.0 No Controls how fast the brightness is changed, e.g. in case touchpad scrolling is used. Negative values swap the scroll direction.

Information on the profiles system can be found here.

JSON 
{
  "end": [
    {
      "type": "brightness",
      "format": "{percentage}%",
      "smooth_scroll_speed": 0.5,
      "mode": {
        "type": "systemd",
        "subsystem": "backlight",
        "name": "amdgpu_bl1"
      },
      "profiles": {
        "low": {
          "when": 25,
          "format": "{percentage}%",
          "icon_label": ""
        },
        "high": {
          "when": 100,
          "format": "{percentage}%",
          "icon_label": ""
        }
      }
    }
  ]
}
TOML 
[[end]]
type = "brightness"
format = "{percentage}%"
smooth_scroll_speed = 0.5

[end.mode]
type = "systemd"
subsystem = "backlight"
name = "amdgpu_bl1"

[end.profiles.low]
when = 25
format = "{percentage}%"
icon_label = ""

[end.profiles.high]
when = 100
format = "{percentage}%"
icon_label = ""
YAML 
end:
  - type: brightness
    format: "{percentage}%"
    smooth_scroll_speed: 0.5

    mode:
      type: systemd
      subsystem: backlight
      name: amdgpu_bl1

    profiles:
      low:
        when: 25
        format: "{percentage}%"
        icon_label: ""
      high:
        when: 100
        format: "{percentage}%"
        icon_label: ""
Corn 
{
  end = [
    {
      type = "brightness"
      format = "{percentage}%"
      smooth_scroll_speed = 0.5

      mode.type = "systemd"
      mode.subsystem = "backlight"
      mode.name = "amdgpu_bl1"

      profiles.low.when = 25
      profiles.low.format = "{percentage}%"
      profiles.low.icon_label = ""

      profiles.high.when = 100
      profiles.high.format = "{percentage}%"
      profiles.high.icon_label = ""
    }
  ]
}

Icons

The icon is configured per profile using the icon_label option.

Brightness ships with default profiles that set icons for percentage ranges:

Profile Threshold (<=) Icon
level0 5
level10 15
level20 25
level30 35
level40 45
level50 55
level60 65
level70 75
level80 85
level90 95
level100 100

Formatting Tokens

The following tokens can be used in the format config option:

Token Description
{percentage} The active brightness percentage.

Styling

Selector Description
.brightness Brightness widget button
.brightness .label text, which is controlled via format
.brightness .icon icon, which is controlled via icon_label

For more information on styling, please see the styling guide.

Guides

Dynamic content

Examples

Custom

Modules

Custom

Clone this wiki locally