Skip to content

dashboard

Quick-access button with a distro icon; opens the dashboard dropdown.

Add it to your layout with dashboard:

toml
[[bar.layout]]
monitor = "*"
right = ["dashboard"]

General

FieldTypeDefaultDescription
icon-overridestring""Override the auto-detected distro icon.
border-showboolfalseDisplay border around button.

Colors

FieldTypeDefaultDescription
border-colorColorValue"yellow"Border color token.
icon-colorColorValue"auto"Icon foreground color. Auto selects based on variant for contrast.
icon-bg-colorColorValue"yellow"Icon container background color token.

Click actions

FieldTypeDefaultDescription
right-clickClickAction""Action on right click.
middle-clickClickAction""Action on middle click.
scroll-upClickAction""Action on scroll up.
scroll-downClickAction""Action on scroll down.
left-clickClickAction"dropdown:dashboard"Action on left click.
FieldTypeDefaultDescription
dropdown-lock-commandstring"loginctl lock-session"Shell command for the lock button in the dashboard dropdown.
dropdown-logout-commandstring"loginctl terminate-session $XDG_SESSION_ID"Shell command for the logout button in the dashboard dropdown.
dropdown-reboot-commandstring"systemctl reboot"Shell command for the reboot button in the dashboard dropdown.
dropdown-poweroff-commandstring"systemctl poweroff"Shell command for the power-off button in the dashboard dropdown.

Default configuration

toml
[modules.dashboard]
icon-override = ""
border-show = false
border-color = "yellow"
icon-color = "auto"
icon-bg-color = "yellow"
right-click = ""
middle-click = ""
scroll-up = ""
scroll-down = ""
left-click = "dropdown:dashboard"
dropdown-lock-command = "loginctl lock-session"
dropdown-logout-command = "loginctl terminate-session $XDG_SESSION_ID"
dropdown-reboot-command = "systemctl reboot"
dropdown-poweroff-command = "systemctl poweroff"

Released under the MIT License.