waybar-image(5) File Formats Manual waybar-image(5)

# [NAME](#NAME)

waybar - image module

# [DESCRIPTION](#DESCRIPTION)

The **image** module displays an image from a path.

# [CONFIGURATION](#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 or float  
The interval (in seconds) to re-render the image.  
Minimum value is 0.001 (1ms). Values smaller than 1ms will be set to 1ms.  
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.

# [SCRIPT OUTPUT](#SCRIPT_OUTPUT)

Similar to the **custom** module, output values of the script are **newline** separated. The following is the output format:

```
$path\n$tooltip
```

# [EXAMPLES](#EXAMPLES)

```
"image#album-art": {
	"path": "/tmp/mpd_art",
	"size": 32,
	"interval": 5,
	"on-click": "mpc toggle"
}
```

# [STYLE](#STYLE)

- **#image**
- **#image.empty**

2026-10-17

---

Document: waybar-image(5) from waybar 0.15.0-r1 (Chainguard OS)