1waybar-image(5)               File Formats Manual              waybar-image(5)
2
3
4

NAME

6       waybar - image module
7

DESCRIPTION

9       The image module displays an image from a path.
10

CONFIGURATION

12       path:
13            typeof: string
14            The path to the image.
15
16       exec:
17            typeof: string
18            The path to the script, which should return image path file.
19            It will only execute if the path is not set
20
21       size:
22            typeof: integer
23            The width/height to render the image.
24
25       interval:
26            typeof: integer
27            The interval (in seconds) to re-render the image.
28            This is useful if the contents of path changes.
29            If no interval is defined, the image will only be rendered once.
30
31       signal:
32            typeof: integer
33            The signal number used to update the module.
34            This can be used instead of interval if the file changes irregu‐
35       larly.
36            The number is valid between 1 and N, where SIGRTMIN+N = SIGRTMAX.
37
38       on-click:
39            typeof: string
40            Command to execute when clicked on the module.
41
42       on-click-middle:
43            typeof: string
44            Command to execute when middle-clicked on the module using mouse‐
45       wheel.
46
47       on-update:
48            typeof: string
49            Command to execute when the module is updated.
50
51       on-scroll-up:
52            typeof: string
53            Command to execute when scrolling up on the module.
54
55       on-scroll-down:
56            typeof: string
57            Command to execute when scrolling down on the module.
58
59       smooth-scrolling-threshold:
60            typeof: double
61            Threshold to be used when scrolling.
62
63       tooltip:
64            typeof: bool
65            default: true
66            Option to enable tooltip on hover.
67

SCRIPT OUTPUT

69       Similar to the custom module, output values of the script is newline
70       separated. The following is the output format:
71
72           $path\n$tooltip
73

EXAMPLES

75           "image#album-art": {
76                "path": "/tmp/mpd_art",
77                "size": 32,
78                "interval": 5,
79                "on-click": "mpc toggle"
80           }
81

STYLE

83       •   #image
84
85
86
87                                  2023-08-16                   waybar-image(5)