diff --git a/options.xhtml b/options.xhtml index e123da1ee..92187be49 100644 --- a/options.xhtml +++ b/options.xhtml @@ -101643,6 +101643,132 @@ boolean

Example: true

+

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/i3-sway/sway.nix> + +
+ +
+ + wayland.windowManager.sway.config.bindswitches + + +
+
+

Binds <switch> to execute the sway command command on state changes. Supported switches are lid (laptop +lid) and tablet (tablet mode) switches. Valid values for state are on, off and toggle. These switches are +on when the device lid is shut and when tablet mode is active respectively. toggle is also supported to run +a command both when the switch is toggled on or off. +See sway(5).

+ +

Type: +attribute set of (submodule)

+ +

Default: +"No bindswitches by default"

+ +

Example:

let
+  laptop = "eDP-1";
+in
+{
+  "lid:on" = {
+    reload = true;
+    locked = true;
+    action = "output ${laptop} disable";
+  };
+  "lid:off" = {
+    reload = true;
+    locked = true;
+    action = "output ${laptop} enable";
+  };
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/i3-sway/sway.nix> + +
+
+
+ + wayland.windowManager.sway.config.bindswitches.<name>.action + + +
+
+

The sway command to execute on state changes

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/i3-sway/sway.nix> + +
+
+
+ + wayland.windowManager.sway.config.bindswitches.<name>.locked + + +
+
+

Unless the flag --locked is set, the command +will not be run when a screen locking program +is active. If there is a matching binding with +and without --locked, the one with will be preferred +when locked and the one without will be +preferred when unlocked.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/window-managers/i3-sway/sway.nix> + +
+
+
+ + wayland.windowManager.sway.config.bindswitches.<name>.reload + + +
+
+

If the --reload flag is given, the binding will +also be executed when the config is reloaded. +toggle bindings will not be executed on reload. +The --locked flag will operate as normal so if +the config is reloaded while locked and +–locked is not given, the binding will not be +executed.

+ +

Type: +boolean

+ +

Default: +false

+

Declared by: