toggle_special

Allows moving the focused window to a special workspace and back (based on the visibility status of that workspace).

It's a companion of togglespecialworkspace Hyprland's command and you most likely will need to configure the two commands for a complete user experience, eg:

bind = $mainMod SHIFT, N, togglespecialworkspace, stash # toggles "stash" special workspace visibility 
bind = $mainMod, N, exec, pypr toggle_special stash # moves window to/from the "stash" workspace

No other configuration needed, here MOD+SHIFT+N will show every window in "stash" while MOD+N will move the focused window out of it/ to it.

Note

Added in version 1.8.0

Commands

• toggle_special [name]: moves the focused window to the special workspace name, or move it back to the active workspace. If none set, "minimized" will be used.

  To toggle the state back to a normal workspace, you'll need to hyprctl dispatch togglespecialworkspace minimized (here "minimized" is used as name, which is the default value when you pypr toggle_special)

  It can also be achieved with a keybinding in hyprland.conf:

  bind = $mainMod SHIFT, N, togglespecialworkspace, minimized