mirror of
				https://github.com/rad4day/Waybar.git
				synced 2025-11-04 09:42:42 +01:00 
			
		
		
		
	Merge branch 'master' into add-river-layout
This commit is contained in:
		@@ -58,16 +58,25 @@ The *backlight* module displays the current backlight level.
 | 
			
		||||
 | 
			
		||||
*on-scroll-up*: ++
 | 
			
		||||
	typeof: string ++
 | 
			
		||||
	Command to execute when performing a scroll up on the module.
 | 
			
		||||
	Command to execute when performing a scroll up on the module. This replaces the default behaviour of brightness control.
 | 
			
		||||
 | 
			
		||||
*on-scroll-down*: ++
 | 
			
		||||
	typeof: string
 | 
			
		||||
	Command to execute when performing a scroll down on the module.
 | 
			
		||||
	Command to execute when performing a scroll down on the module. This replaces the default behaviour of brightness control.
 | 
			
		||||
 | 
			
		||||
*smooth-scrolling-threshold*: ++
 | 
			
		||||
	typeof: double
 | 
			
		||||
	Threshold to be used when scrolling.
 | 
			
		||||
 | 
			
		||||
*reverse-scrolling*: ++
 | 
			
		||||
	typeof: bool ++
 | 
			
		||||
	Option to reverse the scroll direction.
 | 
			
		||||
 | 
			
		||||
*scroll-step*: ++
 | 
			
		||||
	typeof: float ++
 | 
			
		||||
	default: 1.0 ++
 | 
			
		||||
	The speed in which to change the brightness when scrolling.
 | 
			
		||||
 | 
			
		||||
# EXAMPLE:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
waybar-custom(5)
 | 
			
		||||
waybar-image(5)
 | 
			
		||||
 | 
			
		||||
# NAME
 | 
			
		||||
 | 
			
		||||
@@ -10,12 +10,13 @@ The *image* module displays an image from a path.
 | 
			
		||||
 | 
			
		||||
# CONFIGURATION
 | 
			
		||||
 | 
			
		||||
Addressed by *custom/<name>*
 | 
			
		||||
 | 
			
		||||
*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.
 | 
			
		||||
@@ -58,15 +59,15 @@ Addressed by *custom/<name>*
 | 
			
		||||
 | 
			
		||||
# EXAMPLES
 | 
			
		||||
 | 
			
		||||
## Spotify:
 | 
			
		||||
 | 
			
		||||
## mpd:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
"image/album-art": {
 | 
			
		||||
"image#album-art": {
 | 
			
		||||
	"path": "/tmp/mpd_art",
 | 
			
		||||
	"size": 32,
 | 
			
		||||
	"interval": 5,
 | 
			
		||||
	"on-click": "mpc toggle"
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
# STYLE
 | 
			
		||||
 | 
			
		||||
- *#image*
 | 
			
		||||
 
 | 
			
		||||
@@ -66,6 +66,25 @@ Addressed by *sway/window*
 | 
			
		||||
	default: true ++
 | 
			
		||||
	Option to disable tooltip on hover.
 | 
			
		||||
 | 
			
		||||
*all-outputs*: ++
 | 
			
		||||
	typeof: bool ++
 | 
			
		||||
	default: false ++
 | 
			
		||||
	Option to show the focused window along with its workspace styles on all outputs.
 | 
			
		||||
 | 
			
		||||
*offscreen-css*: ++
 | 
			
		||||
	typeof: bool ++
 | 
			
		||||
	default: false ++
 | 
			
		||||
	Only effective when all-outputs is true. Adds style according to present windows on unfocused outputs instead of showing the focused window and style.
 | 
			
		||||
 | 
			
		||||
*offscreen-css-text*: ++
 | 
			
		||||
	typeof: string ++
 | 
			
		||||
	Only effective when both all-outputs and offscreen-style are true. On screens currently not focused, show the given text along with that workspaces styles.
 | 
			
		||||
 | 
			
		||||
*show-focused-workspace-name*: ++
 | 
			
		||||
	typeof: bool ++
 | 
			
		||||
	default: false ++
 | 
			
		||||
	If the workspace itself is focused and the workspace contains nodes or floating_nodes, show the workspace name. If not set, text remains empty but styles according to nodes in the workspace are still applied.
 | 
			
		||||
	
 | 
			
		||||
*rewrite*: ++
 | 
			
		||||
	typeof: object ++
 | 
			
		||||
	Rules to rewrite window title. See *rewrite rules*.
 | 
			
		||||
@@ -117,6 +136,10 @@ Invalid expressions (e.g., mismatched parentheses) are skipped.
 | 
			
		||||
# STYLE
 | 
			
		||||
 | 
			
		||||
- *#window*
 | 
			
		||||
- *window#waybar.empty* When no windows is in the workspace
 | 
			
		||||
- *window#waybar.solo* When one window is in the workspace
 | 
			
		||||
- *window#waybar.empty* When no windows are in the workspace, or screen is not focused and offscreen-css option is not set
 | 
			
		||||
- *window#waybar.solo* When one tiled window is in the workspace
 | 
			
		||||
- *window#waybar.floating* When there are only floating windows in the workspace
 | 
			
		||||
- *window#waybar.stacked* When there is more than one window in the workspace and the workspace layout is stacked
 | 
			
		||||
- *window#waybar.tabbed* When there is more than one window in the workspace and the workspace layout is tabbed
 | 
			
		||||
- *window#waybar.tiled* When there is more than one window in the workspace and the workspace layout is splith or splitv
 | 
			
		||||
- *window#waybar.<app_id>* Where *app_id* is the app_id or *instance* name like (*chromium*) of the only window in the workspace
 | 
			
		||||
 
 | 
			
		||||
@@ -263,6 +263,7 @@ A module group is defined by specifying a module named "group/some-group-name".
 | 
			
		||||
- *waybar-custom(5)*
 | 
			
		||||
- *waybar-disk(5)*
 | 
			
		||||
- *waybar-idle-inhibitor(5)*
 | 
			
		||||
- *waybar-image(5)*
 | 
			
		||||
- *waybar-keyboard-state(5)*
 | 
			
		||||
- *waybar-memory(5)*
 | 
			
		||||
- *waybar-mpd(5)*
 | 
			
		||||
@@ -278,6 +279,7 @@ A module group is defined by specifying a module named "group/some-group-name".
 | 
			
		||||
- *waybar-sway-scratchpad(5)*
 | 
			
		||||
- *waybar-sway-window(5)*
 | 
			
		||||
- *waybar-sway-workspaces(5)*
 | 
			
		||||
- *waybar-wireplumber(5)*
 | 
			
		||||
- *waybar-wlr-taskbar(5)*
 | 
			
		||||
- *waybar-wlr-workspaces(5)*
 | 
			
		||||
- *waybar-temperature(5)*
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user