Skip to content

dashboard ​

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

Add it to your layout with dashboard:

yaml
bar:
  layout:
    - monitor: "*"
      right: [dashboard]

General ​

FieldTypeDefaultDescription
icon-overridestring""Override the auto-detected distro icon.
border-showboolfalseDisplay border around button.
usage-warningf3260CPU/RAM/disk usage percent at which the dashboard rings turn warning.
usage-errorf3285CPU/RAM/disk usage percent at which the dashboard rings turn error.
temp-warningf3265CPU temperature (°C) at which the dashboard temp ring turns warning.
temp-errorf3285CPU temperature (°C) at which the dashboard temp ring turns error.
battery-warningf3230Battery percent at or below which the dashboard battery shows warning.
battery-criticalf3215Battery percent at or below which the dashboard battery shows critical.
user-sessionUserSessionConfig{...}User session configuration

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"lys-shell logout"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 ​

yaml
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: lys-shell logout
    dropdown-reboot-command: systemctl reboot
    dropdown-poweroff-command: systemctl poweroff
    usage-warning: 60.0
    usage-error: 85.0
    temp-warning: 65.0
    temp-error: 85.0
    battery-warning: 30.0
    battery-critical: 15.0
    user-session:
      actions:
        - lock
        - log-out
        - reboot
        - power-off

Released under the MIT License.