The workspaces module displays the currently used workspaces in Sway.

Addressed by sway/workspaces

warp-on-scroll:
typeof: bool
default: true
If set to false, you can scroll to cycle through workspaces without mouse warping being enabled. If set to true this behaviour is disabled.

{value}: Name of the workspace, as defined by sway.

{name}: Number stripped from workspace value.

{icon}: Icon, as defined in format-icons.

{index}: Index of the workspace.

{output}: Output where the workspace is located.

{windows}: Result from window-rewrite

Additional to workspace name matching, the following format-icons can be set.

• default: Will be shown, when no string matches are found.

• urgent: Will be shown, when workspace is flagged as urgent

• focused: Will be shown, when workspace is focused

• persistent: Will be shown, when workspace is persistent.

• high-priority-named: Icons by names will be shown always for those workspaces, independent by state.

Each entry of persistent_workspace names a workspace that should always be shown. Associated with that value is a list of outputs indicating where the workspace should be shown, an empty list denoting all outputs.

"sway/workspaces": {
	"persistent-workspaces": {
		"3": [], // Always show a workspace with name '3', on all outputs if it does not exist
		"4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exist
		"5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exist
		"6": ["MonitorMaker 3000 ABC0123"], // Always show a workspace with name '6' on outputs with an identifier 'MonitorMaker 3000 ABC0123' (usually a triple of vendor/model/serial)
	}
}

n.b.: the list of outputs can be obtained from command line using swaymsg -t get_outputs

"sway/workspaces": {
	"disable-scroll": true,
	"all-outputs": true,
	"format": "{name}: {icon}",
	"format-icons": {
		"1": "",
		"2": "",
		"3": "",
		"4": "",
		"5": "",
		"high-priority-named": [ "1", "2" ],
		"urgent": "",
		"focused": "",
		"default": ""
	}
}

"sway/workspaces": {
  "format": "<span size='larger'>{name}</span> {windows}",
  "format-window-separator": " | ",
  "window-rewrite-default": "{name}",
  "window-rewrite": {
    "class<firefox>": "",
    "class<kitty>": "k",
	"title<.* - (.*) - VSCodium>": "codium $1"  // captures part of the window title and formats it into output
  }
}

"sway/workspaces": {
	"format": "{index} - {name}",
	"format-for-negative-index": "{name}"
}

• #workspaces button

• #workspaces button.visible

• #workspaces button.focused

• #workspaces button.urgent

• #workspaces button.persistent

• #workspaces button.empty

• #workspaces button.current_output

• #workspaces button#sway-workspace-${name}

• #workspaces button.${output-class}

The window module displays the title of the currently focused window in Sway

Addressed by sway/window

{title}: The title of the focused window.

{app_id}: The app_id of the focused window.

{shell}: The shell of the focused window. It's 'xwayland' when the window is running through xwayland, otherwise, it's 'xdg-shell'.

{marks}: Marks of the window.

rewrite is an object where keys are regular expressions and values are rewrite rules if the expression matches. Rules may contain references to captures of the expression.

Regular expression and replacement follow ECMA-script rules.

If no expression matches, the format output is left unchanged.

Invalid expressions (e.g., mismatched parentheses) are skipped.

"sway/window": {
	"format": "{}",
	"max-length": 50,
	"rewrite": {
		"(.*) - Mozilla Firefox": "🌎 $1",
		"(.*) - zsh": "> [$1]"
	}
}

• #window

The following classes are applied to the entire Waybar rather than just the window widget:

• 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

These additional classes are applied to the whole Waybar (an element with the name window and the id waybar) rather than to the module widget itself (an element with the name box and the id window). In most cases you therefore want to target window#waybar.<stylename> #window to style the module.

Switching layouts does not change the style unless the focus is changed. Sway does not provide events for layout switching and the module does not poll.

The mode module displays the current binding mode of Sway

Addressed by sway/mode

"sway/mode": {
	"format": " {}",
	"max-length": 50
}

• #mode

The scratchpad module displays the scratchpad status in Sway

Addressed by sway/scratchpad

{icon}: Icon, as defined in format-icons.

{count}: Number of windows in the scratchpad.

{app}: Name of the application in the scratchpad.

{title}: Title of the application in the scratchpad.

"sway/scratchpad": {
	"format": "{icon} {count}",
	"show-empty": false,
	"format-icons": ["", ""],
	"tooltip": true,
	"tooltip-format": "{app}: {title}"
}

• #scratchpad

• #scratchpad.empty