(Widget) Brightness

Brightness Screen Widget Configuration

Option	Type	Default	Description
label	string	"{icon}"	The format string for the brightness widget.
label_alt	string	"Brightness {percent}%"	The alternative format string for the brightness widget.
tooltip	boolean	True	Whether to show the tooltip on hover.
scroll_step	integer	1	The step size for scrolling the brightness level. This value must be between 1 and 100.
brightness_icons	list	['\udb80\udcde', '\udb80\udcdd', '\udb80\udcdf', '\udb80\udce0']	A list of icons representing different brightness levels. The icons are used based on the current brightness percentage.
hide_unsupported	boolean	True	Whether to hide the widget if the current system does not support brightness control.
brightness_toggle_level	list	[0, 50, 100]	The brightness levels to cycle through when the widget is clicked.
auto_light	boolean	False	Whether to automatically adjust the brightness icon based on the current brightness level.
auto_light_icon	string	"\udb80\udce1"	The icon to use when the auto_light option is enabled.
auto_light_night_level	int	50	The brightness level at which the widget switches to the night.
auto_light_day_level	int	100	The brightness level at which the widget switches to the day.
auto_light_night_start_time	string	"20:00"	The time at which the night starts.
auto_light_night_end_time	string	"06:30"	The time at which the night ends.
brightness_menu	dict	{'blur': True, 'round_corners': True, 'round_corners_type': 'normal', 'border_color': 'System', 'alignment': 'right', 'direction': 'down', 'offset_top': 6, 'offset_left': 0}	Menu settings for the widget.
callbacks	dict	{'on_left': 'toggle_label', 'on_middle': 'do_nothing', 'on_right': 'do_nothing'}	Callbacks for mouse events on the brightness widget.
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.
progress_bar	dict	{'enabled': False, 'position': 'left', 'size': 14, 'thickness': 2, 'color': '#57948a', animation: True}	Progress bar settings.

Example Configuration

  brightness:
    type: "yasb.brightness.BrightnessWidget"
    options:
      label: "<span>{icon}</span>"
      label_alt: "Brightness {percent}%"
      tooltip: true
      hide_unsupported: true
      brightness_toggle_level: [0, 50, 100]
      auto_light: false
      auto_light_icon: "\udb80\udce1"
      auto_light_night_level: 35
      auto_light_night_start_time: "19:00"
      auto_light_night_end_time: "06:45"
      auto_light_day_level: 75
      brightness_icons: [
        "\udb80\udcde",  # Icon for 0-25% brightness
        "\udb80\udcdd",  # Icon for 26-50% brightness
        "\udb80\udcdf",  # Icon for 51-75% brightness
        "\udb80\udce0"   # Icon for 76-100% brightness
      ]
      brightness_menu:
        blur: true
        round_corners: true
        round_corners_type: "normal"
        border_color: "System"
        alignment: "right"
        direction: "down"
      callbacks:
          on_left: "toggle_label"
      label_shadow:
        enabled: true
        color: "black"
        radius: 3
        offset: [ 1, 1 ]

Description of Options

• label: The format string for the label. You can use placeholders like {icon} or {percent} to dynamically insert information.
• label_alt: The alternative format string for the brightness widget. Useful for displaying additional information like percentage.
• tooltip: Whether to show the tooltip on hover.
• scroll_step: The step size for scrolling the brightness level. This value must be between 1 and 100.
• brightness_icons: A list of icons representing different brightness levels. The icons are used based on the current brightness percentage.
• hide_unsupported: Whether to hide the widget if the current system does not support brightness control.
• brightness_toggle_level: The brightness level to set when the widget is clicked.
• brightness_menu: A dictionary specifying the menu settings for the widget. It contains the following keys:
  • blur: Enable blur effect for the menu.
  • round_corners: Enable round corners for the menu (this option is not supported on Windows 10).
  • round_corners_type: Set the type of round corners for the menu (normal, small) (this option is not supported on Windows 10).
  • border_color: Set the border color for the menu (this option is not supported on Windows 10).
  • alignment: Set the alignment of the menu (left, right).
  • direction: Set the direction of the menu (up, down).
  • offset_top: Set the top offset of the menu.
  • offset_left: Set the left offset of the menu.
• auto_light: Whether to automatically adjust the brightness icon based on the current brightness level.
• auto_light_icon: The icon to use when the auto_light option is enabled.
• auto_light_night_level: The brightness level at which the widget switches to the night.
• auto_light_day_level: The brightness level at which the widget switches to the day.
• auto_light_night_start_time: The time at which the night starts.
• auto_light_night_end_time: The time at which the night ends.
• callbacks: Callbacks for mouse events on the brightness widget. can be toggle_brightness_menu, toggle_label, toggle_level_next, toggle_level_prev, do_nothing.
• 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.
• progress_bar: A dictionary containing settings for the progress bar. It includes:
  • enabled: Whether the progress bar is enabled.
  • position: The position of the progress bar, either "left" or "right".
  • size: The size of the progress bar.
  • thickness: The thickness of the progress bar.
  • color: The color of the progress bar. Color can be single color or gradient. For example, color: "#57948a" or color: ["#57948a", "#ff0000"]" for a gradient.
  • background_color: The background color of the progress bar.
  • animation: Whether to enable smooth change of the progress bar value.

Example Style

.brightness-widget {}
.brightness-widget .widget-container {}
.brightness-widget .widget-container .label {}
.brightness-widget .widget-container .icon {}

Style for the brightness menu

.brightness-menu {
    background-color:rgba(17, 17, 27, 0.4); 
}
.brightness-slider {
    border: none;
}
.brightness-slider::groove {}
.brightness-slider::handle{} 

/* Brightness progress bar styles if enabled */
.brightness-widget .progress-circle {}