Key Bindings

sweets.bind(spec, action [, arg]) maps a key combination or short key sequence to a compositor action.

sweets.bind(spec, action [, arg])

spec is one or more whitespace-separated key combinations. A combination is a +-separated string of modifiers and one key, e.g. "MOD+Shift+Return". MOD expands to mod_key; other modifiers are Shift, Ctrl, Alt, Super. The key name is matched case-insensitively (so q and Q are the same key; use Shift for the shifted action). Keys use xkb names (Return, space, 1, q, …), including the XF86 multimedia keysyms such as XF86AudioRaiseVolume, XF86AudioMute, and XF86MonBrightnessUp for media keys (see Media keys).

sweets.bind("MOD+Return", "spawn", "foot")
sweets.bind("MOD+q", "close")
sweets.bind("MOD+Shift+q", "quit")

Key sequences

Put spaces between steps to create Emacs/Vim-style sequences. For example, release MOD after b, then press f or c:

sweets.bind("MOD+b f", "spawn", "firefox")
sweets.bind("MOD+b c", "spawn", "chromium")

The first step is consumed while Sweets waits for the next one. A sequence times out after one second; an unmatched next key also cancels it and is consumed. Pressing Escape is therefore a harmless way to cancel a pending sequence. Sequences may contain up to eight steps, and each step may have its own modifiers. One sequence cannot be the prefix of another binding: use distinct bindings rather than combining, for example, "MOD+b" and "MOD+b f".

Actions

scratchpad_toggle and scratchpad_move are accepted compatibility aliases for the special-workspace actions.

Default bindings come from the packaged Lua config. A user config can replace any single default by binding the same key combo again; defaults that are not rebound stay active.

Default bindings

These bindings are defined by the packaged Lua config and remain active unless the user config replaces them.

MOD is the configured mod_key (default SUPER).

The special workspace is a private, modal workspace shown as a dimmed overlay on the active output. Every assigned window appears together using the normal master/stack layout and gap settings. Windows mapped while it is open join the same special workspace automatically. Configure the dim color with sweets.special({ dim = "#000000A6" }).

Media keys

The packaged config also binds the XF86 multimedia keys to external helper commands via spawn. They have no modifier, so they work straight from a laptop's volume/brightness/playback keys. Each needs the matching tool installed; rebind or remove them in your user config if you use different tools.