(Widget) Traffic - thesleepingsage/yasb-wiki GitHub Wiki

Traffic Widget Options

Option Type Default Description
label string '\ueb01 \ueab4 {download_speed} - \ueab7 {upload_speed}' The format string for the traffic widget. Displays download and upload speeds.
label_alt string 'Download {download_speed} - Upload {upload_speed}' The alternative format string for the traffic widget. Displays upload and download speeds.
update_interval integer 1000 The interval in milliseconds to update the traffic data. Must be between 0 and 60000.
interface string Auto The network interface to monitor. If not specified, the widget will use the default interface.
hide_if_offline boolean False Hide the widget if the network interface is offline.
max_label_length integer 0 The maximum length of the label.
callbacks dict {'on_left': 'toggle_label', 'on_middle': 'do_nothing', 'on_right': 'do_nothing'} Callbacks for mouse events on the traffic widget.
animation dict {'enabled': True, 'type': 'fadeInOut', 'duration': 200} Animation settings for the widget.
container_padding dict {'top': 0, 'left': 0, 'bottom': 0, 'right': 0} Explicitly set padding inside widget container.
container_shadow dict None Container shadow options.
label_shadow dict None Label shadow options.

Example Configuration

traffic:
  type: "yasb.traffic.TrafficWidget"
  options:
    label: "\ueb01 \ueab4 {download_speed} | \ueab7 {upload_speed}"
    label_alt: "Download {download_speed} | Upload {upload_speed}"
    update_interval: 1000
    callbacks:
      on_left: "toggle_label"
      on_right: "exec cmd /c Taskmgr"
    label_shadow:
      enabled: true
      color: "black"
      radius: 3
      offset: [ 1, 1 ]

Description of Options

  • label: The format string for the traffic widget. Displays download and upload speeds.
  • label_alt: The alternative format string for the traffic widget. Displays upload and download speeds.
  • update_interval: The interval in milliseconds to update the traffic data. Must be between 0 and 60000.
  • interface: The network interface to monitor. If not specified, the widget will use the default interface.
  • hide_if_offline: Hide the widget if the network interface is offline.
  • max_label_length: The maximum length of the label.
  • 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_padding: Explicitly set padding inside widget container. Use this option to set padding inside the widget container. You can set padding for top, left, bottom and right sides of the widget container.
  • container_shadow: Container shadow options.
  • label_shadow: Label shadow options.

Example Style

.traffic-widget {}
.traffic-widget .widget-container {}
.traffic-widget .label {}
.traffic-widget .label.alt {}
.traffic-widget .icon {}
⚠️ **GitHub.com Fallback** ⚠️