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, such as "MOD+Shift+Return".

• MOD expands to mod_key. Other modifiers are Shift, Ctrl, Alt, and Super.
• Key names match case-insensitively, so q and Q are the same key. Use Shift for the shifted action.
• Keys use xkb names: Return, space, 1, q, and the XF86 multimedia keysyms. 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 for Emacs/Vim-style sequences. 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. A sequence times out after one second. An unmatched next key cancels it and is consumed, so Escape is a harmless way to cancel.

Sequences may have up to eight steps, each with its own modifiers. One sequence cannot be the prefix of another binding — do not combine "MOD+b" and "MOD+b f".

Actions

Notes on the directional actions:

• Focus and move actions can cross monitors. See focus_cross_monitor and move_cross_monitor.
• move_* on a window in a tabbed group carries the whole group. move_eject_* peels off just the focused tab, and falls back to a plain move_* when the window is ungrouped.
• cycle_tab, move_tab, and eject are no-ops unless the focused window is in a group.

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

Default bindings come from the packaged Lua config. A user config replaces any default by binding the same combo again. Defaults that are not rebound stay active.

Default bindings

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. Its windows use the normal layout and gap settings. Windows mapped while it is open join it automatically. Set the dim color with sweets.special({ dim = "#000000A6" }).

Media keys

The packaged config binds the XF86 multimedia keys to helper commands via spawn. They have no modifier, so they work straight from a laptop's keys. Each needs the matching tool installed.