Skip to content

(Widget) Home

github-actions edited this page Sep 9, 2025 · 11 revisions

Home Menu Widget Configuration

Option Type Default Description
label string "\udb81\udf17" Icon or text for button.
menu_list list [] List of menu items. title and path
system_menu boolean true Show system menu.
power_menu boolean true Show power menu.
blur boolean true Blur background.
round_corners boolean true Round corners.
round_corners_type string 'normal' Round corners type. Possible values: 'normal', 'small'.
border_color string 'System' Border color.
alignment string "left" Alignment of the menu. Possible values: "left", "center", "right".
direction string "down" Direction of the menu. Possible values: "up", "down".
offset_top int 6 Distance from the top or bottom edge of the bar.
offset_left int 0 Distance from the left or right edge of the bar.
menu_labels dict {'shutdown': 'Shutdown', 'restart': 'Restart', 'logout': 'Logout', 'lock': 'Lock', 'sleep': 'Sleep', 'system': 'System Settings', 'about': 'About This PC', 'task_manager': 'Task Manager'} Custom label names for system and power items.
animation dict {'enabled': True, 'type': 'fadeInOut', 'duration': 200} Animation settings for the widget.
container_shadow dict None Container shadow options.
label_shadow dict None Label shadow options.

Example Configuration

home:
  type: "yasb.home.HomeWidget"
  options:
    label: "<span>\udb81\udf17</span>"
    menu_list:
    - { title: "User Home", path: "~" }
    - { title: "Download", path: "D:\\Downloads" }
    - { title: "Documents", path: "C:\\Users\\amn\\Documents" }
    - { title: "Pictures", path: "C:\\Users\\amn\\Pictures" }
    system_menu: true
    power_menu: true
    blur: true
    round_corners: true
    round_corners_type: "normal"
    border_color: "System"
    offset_top: 6
    offset_left: 0
    alignment: "left"
    direction: "down"
    menu_labels:
      shutdown: "Shutdown"
      restart: "Restart"
      hibernate: "Hibernate"
      logout: "Logout"
      lock: "Lock"
      sleep: "Sleep"
      system: "System Settings"
      about: "About This PC"
      task_manager: "Task Manager"
    label_shadow:
      enabled: true
      color: "black"
      radius: 3
      offset: [ 1, 1 ]

Description of Options

  • label: Icon or text for button.
  • menu_list: List of menu items (title and path). Use this list only for directories; do not use it for applications or files.
  • system_menu: Show system menu. Enabling this option will show system menu items like settings, task manager and About this PC.
  • power_menu: Show power menu. Enabling this option will show power menu items like shutdown, restart, sleep, lock and sign out.
  • blur: Blur background. Enabling this option will blur the background and add default OS radius and border to the widget.
  • round_corners: Round corners. Enabling this option will add round corners to the widget.
  • round_corners_type: Round corners type. Possible values: 'normal', 'small'.
  • border_color: Border color. Border color for bar can be None, System or Hex Color "#ff0000". (This applies to system round_corners and if round_corners is True.)
  • alignment: Alignment of the menu. Possible values: "left", "center", "right".
  • direction: Direction of the menu. Possible values: "up", "down".
  • offset_top: Distance from the top or bottom edge of the bar.
  • offset_left: Distance from the left or right edge of the bar.
  • menu_labels: Custom label names for system and power items. Use this option to change the default labels for system and power menu items.
  • animation: A dictionary specifying the animation settings for the widget. It contains three keys: enabled, type, and duration. The type can be fadeInOut and the duration is the animation duration in milliseconds.
  • container_shadow: Container shadow options.
  • label_shadow: Label shadow options.

Example Style

.home-widget {
    padding: 0 4px 0 12px;
}
.home-widget .icon {
    color: #b4befe;
}
.home-widget .icon:hover {
    color: #cdd6f4;
}
.home-menu {
    background-color:rgba(17, 17, 27, 0.5); 
}
.home-menu .menu-item {
    padding: 6px 48px 7px 16px;
    font-size: 12px;
    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
    color: var(--text); 
    font-weight: 600;
}
.home-menu .menu-item:hover {
    background-color:rgba(128, 130, 158, 0.15);
    color: #fff;
}
.home-menu .separator {
    max-height: 1px;
    background-color:rgba(128, 130, 158, 0.3);
}

Home YASB Widget

Clone this wiki locally