Active Window Widget Options

Example Configuration

active_window:
  type: "yasb.active_window.ActiveWindowWidget"
  options:
    label: "{win[title]}"
    label_alt: "[class_name='{win[class_name]}' exe='{win[process][name]}' hwnd={win[hwnd]}]"
    label_no_window: ""
    label_icon: true
    label_icon_size: 16
    max_length: 56
    max_length_ellipsis: "..."
    monitor_exclusive: true
    label_shadow:
      enabled: true
      color: "black"
      radius: 3
      offset: [ 1, 1 ]

Description of Options

• label: The format string for the active window title. You can use placeholders to dynamically insert window information. See Label Format Placeholders below.
• label_alt: The alternative format string for the active window. Useful for displaying additional window details. Supports the same placeholders as label.
• class_name: Additional CSS class name for the widget. This allows for custom styling.
• label_no_window: The text to display when no window is active. If not specified, it defaults to an empty string.
• label_icon: A boolean indicating whether to display the window icon.
• label_icon_size: The size of the window icon in pixels. Must be between 12px and 24px.
• max_length: The maximum number of characters to display for the window title. If the title exceeds this length, it will be truncated.
• max_length_ellipsis: The string to append to truncated window titles.
• monitor_exclusive: A boolean indicating whether the widget should be exclusive to a single monitor.
• ignore_window: A dictionary specifying which windows to ignore. It contains three lists: classes, processes, and titles.
• callbacks: A dictionary specifying the callbacks for mouse events. The keys are on_left, on_middle, and on_right, and the values are the names of the callback functions.
• 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.
• rewrite: A dictionary containing rewrite options for the widget. Rewrite rules are applied to title, process.name, and app_name. See Rewrite Options below.

Label Format Placeholders

You can use the following placeholders in label and label_alt:

Label Examples

# Show just the window title
label: "{win[title]}"

# Show friendly app name
label: "{win[app_name]}"

# Show app name followed by window title
label: "{win[app_name]} - {win[title]}"

# Show process name and title
label: "{win[process][name]}: {win[title]}"

# Show detailed info on alt label
label_alt: "[{win[app_name]}] class='{win[class_name]}' exe='{win[process][name]}' pid={win[process][pid]}"

Rewrite Options

The rewrite option allows you to supply a list of search-and-replace rules to be applied, in order, to the window title. Each rule is a dict with the following schema:

Example

active_window:
  type: "yasb.active_window.ActiveWindowWidget"
  options:
    label: "{win[title]}"
    # …
    rewrite:
      # Strip trailing “.exe” (case-insensitive) and lowercase:
      - pattern: "^(.+?)\\.exe$"
        replacement: "\\1"
        case: lower

      # Uppercase the literal word “Studio” anywhere in the title:
      - pattern: "\\bStudio\\b"
        replacement: "STUDIO"

      # Replace any title like “…YASB Reborn - Foo” with “🌎 Foo”
      - pattern: "(.*)YASB Reborn -(.*)$"
        replacement: "🌎 \\2"

Example Style

.active-window-widget {}
.active-window-widget.your_class {} /* If you are using class_name option */
.active-window-widget .widget-container {}
.active-window-widget .widget-container .label {}
.active-window-widget .widget-container .label.alt {}
.active-window-widget .widget-container .icon {}