brightness
Backlight control bar module.
Add it to your layout with brightness:
toml
[[bar.layout]]
monitor = "*"
right = ["brightness"]General
| Field | Type | Default | Description |
|---|---|---|---|
level-icons | array of string | [...] | Icons for brightness levels from low to maximum. |
border-show | bool | false | Display border around button. |
icon-show | bool | true | Display module icon. |
label-show | bool | true | Display percentage label. |
format | string | "{{ percent }}%" | Format string for the label. |
label-max-length | u32 | 0 | Max label characters before truncation with ellipsis. Set to 0 to disable. |
thresholds | array of ThresholdEntry | [] | Dynamic color thresholds based on brightness percentage. |
More about level-icons
The percentage is divided evenly among icons. With 3 icons: 0-33% uses icons[0], 34-66% uses icons[1], 67-100% uses icons[2].
More about thresholds
Entries are checked in order; the last matching entry wins for each color slot. Use below for low-brightness warnings.
Example
toml
[[modules.brightness.thresholds]]
below = 20
icon-color = "status-warning"
label-color = "status-warning"Colors
| Field | Type | Default | Description |
|---|---|---|---|
border-color | ColorValue | "yellow" | Border color token. |
icon-color | ColorValue | "auto" | Icon foreground color. Auto selects based on variant for contrast. |
icon-bg-color | ColorValue | "yellow" | Icon container background color token. |
label-color | ColorValue | "yellow" | Label text color token. |
button-bg-color | ColorValue | "bg-surface-elevated" | Button background color token. |
Click actions
| Field | Type | Default | Description |
|---|---|---|---|
left-click | ClickAction | "dropdown:brightness" | Action on left click. Default opens the brightness dropdown. |
right-click | ClickAction | "" | Action on right click. |
middle-click | ClickAction | "" | Action on middle click. |
scroll-up | ClickAction | "" | Action on scroll up. |
scroll-down | ClickAction | "" | Action on scroll down. |
Default configuration
toml
[modules.brightness]
level-icons = [
"ld-sun-dim-symbolic",
"ld-sun-medium-symbolic",
"ld-sun-symbolic",
]
border-show = false
border-color = "yellow"
icon-show = true
icon-color = "auto"
icon-bg-color = "yellow"
label-show = true
label-color = "yellow"
format = "{{ percent }}%"
label-max-length = 0
button-bg-color = "bg-surface-elevated"
left-click = "dropdown:brightness"
right-click = ""
middle-click = ""
scroll-up = ""
scroll-down = ""
thresholds = []