Install Now
waybar - image module
Contents
Configuration
path:
typeof: string
The path to the image.
exec:
typeof: string
The path to the script, which should return image path file.
It will only execute if the path is not set
size:
typeof: integer
The width/height to render the image.
interval:
typeof: integer
The interval (in seconds) to re-render the image.
This is useful if the contents of path changes.
If no interval is defined, the image will only be rendered once.
signal:
typeof: integer
The signal number used to update the module.
This can be used instead of interval if the file changes irregularly.
The number is valid between 1 and N, where SIGRTMIN+N = SIGRTMAX.
on-click:
typeof: string
Command to execute when clicked on the module.
on-click-middle:
typeof: string
Command to execute when middle-clicked on the module using mousewheel.
on-update:
typeof: string
Command to execute when the module is updated.
on-scroll-up:
typeof: string
Command to execute when scrolling up on the module.
on-scroll-down:
typeof: string
Command to execute when scrolling down on the module.
smooth-scrolling-threshold:
typeof: double
Threshold to be used when scrolling.
tooltip:
typeof: bool
default: true
Option to enable tooltip on hover.
expand:
typeof: bool
default: false
Enables this module to consume all left over space dynamically.
Description
The image module displays an image from a path.
Examples
"image#album-art": {
"path": "/tmp/mpd_art",
"size": 32,
"interval": 5,
"on-click": "mpc toggle"
}
Name
waybar - image module
Script Output
Similar to the custom module, output values of the script are newline separated. The following is the
output format:
$path\n$tooltip
Style
• #image
• #image.empty
2025-02-21 waybar-image(5)
PNG Icons
