Module swaystatus::blocks::toggle

A Toggle block

You can add commands to be executed to disable the toggle (command_off), and to enable it (command_on). If these command exit with a non-zero status, the block will not be toggled and the block state will be changed to give a visual warning of the failure. You also need to specify a command to determine the state of the toggle (command_state). When the command outputs nothing, the toggle is disabled, otherwise enabled. By specifying the interval property you can let the command_state be executed continuously.

To run those commands, the shell form $SHELL environment variable is used. If such variable is not presented, sh is used.

Configuration

Key	Values	Required	Default
text	A label next to the icon	No	""
command_on	Shell command to enable the toggle	Yes	N/A
command_off	Shell command to disable the toggle	Yes	N/A
command_state	Shell command to determine the state. Empty output => No, otherwise => Yes.	Yes	N/A
icon_on	Icon override for the toggle button while on	No	"toggle_on"
icon_off	Icon override for the toggle button while off	No	"toggle_off"
interval	Update interval in seconds. If not set, command_state will run only on click.	No	None

Examples

This is what can be used to toggle an external monitor configuration:

[[block]]
block = "toggle"
text = "4k"
command_state = "xrandr | grep 'DP1 connected 38' | grep -v eDP1"
command_on = "~/.screenlayout/4kmon_default.sh"
command_off = "~/.screenlayout/builtin.sh"
interval = 5

Icons Used

• toggle_off
• toggle_on

Structs

ToggleConfig

Functions

run