Sweets

Overview

See and select your live numbered workspaces

Press MOD+O to see your workspaces in a live grid on each monitor.

sweets.bind("MOD+O", "toggle_overview")
ControlAction
Click a window or tileSelect it and return to the desktop
Arrows or directional focus bindingsSelect a window or empty tile
ReturnReturn to the desktop with your selection
Escape or click outside the tilesClose without selecting
Drag a windowReorder it or move it to another workspace
Middle-click a windowClose it, respecting close protection

While dragging, the window floats above workspace tiles in either style and follows the pointer.

Leave fullscreen or maximized mode before dragging. Drop outside the tiles to cancel. Your bindings override the arrow keys, Escape and Return. Panels and launchers keep accepting input.

You can also bind toggle_overview to a mouse button or hot corner.

Open or close from a script

sweets msg overview open
sweets msg overview close

Repeating either command keeps the same requested state. See Overview IPC for state queries and notifications.

Drag files between workspaces

Choose a corner to open Overview while dragging a file:

sweets.hot_corner("top-left", "toggle_overview")

Start dragging, then move into that corner. Hold over a workspace for three quarters of a second to enter it. Keep holding the button, move onto the destination window, then drop.

In the scrolling view, hold near the top or bottom edge to browse workspaces. Wait until Overview closes before dropping. This works with native Wayland applications.

Window hints

Choose a window directly by typing its label:

sweets.bind("MOD+J", "toggle_overview_hints")

Open Overview, then press MOD+J to show labels on visible windows. Type a label to select its window and return to the desktop.

Choose letters that suit your keyboard:

sweets.overview({ hint_keys = "asdfghjkl" })

Scrolling view

sweets.overview({ style = "scrolling", empty = "one" })

Show a vertical workspace strip on each monitor. Previews keep their size as you add workspaces.

Scroll with the wheel or touchpad. Touchpad scrolling snaps to the nearest workspace. Browsing keeps your selection, arrow keys change it. Drag near the top or bottom edge to scroll while moving a window.

animations.overview controls scroll animations. Set style = "grid" to restore the default view. columns applies only to the grid.

Touchpad gesture

sweets.gesture({ fingers = 3, direction = "vertical", action = "overview" })

Swipe up to open and down to close. gestures.natural = false reverses this. The zoom follows your fingers, even with animations off. Short, slow swipes cancel.

See gesture settings for fingers, modifiers and sensitivity. Close any special workspace before swiping.

Zoom animation

Add overview to your animations table:

sweets.animations({
    enabled = true,
    overview = { enabled = true, duration = 220, curve = "default" },
})

Set overview.enabled = false or duration = 0 for an instant grid.

Appearance

Set only the fields you want to change:

sweets.overview({
    tile = "wallpaper",
    numbers = true,
    shadow = true,
})
FieldDefaultEffect
style"grid""grid" or a vertical "scrolling" strip
columns0Automatic, or 1..10 columns; grid only
gap32Tile spacing, 0..256 logical pixels
max_scale0.5Maximum tile scale, 0.1..0.9; shrinks to fit
empty"show""show" all, "hide" unselected empty tiles, or "one" empty tile per monitor
backdrop"#000000A6"Background dim color
tile"#12121C"Tile color or "wallpaper"
numbersfalseShow workspace numbers
hint_keys"asdfghjklqwertyuiopzxcvbnm"2–26 different lowercase Latin letters for window hints
shadowfalseTile shadows using your sweets.shadow style
corner_radius8Tile rounding, 0..64 logical pixels
selected"#C27AFF"Selection and hover ring color
selected_width4Ring width, 0..16 logical pixels; 0 hides rings

Colors accept #RRGGBB and #RRGGBBAA. Changes apply on reload, even with the grid open.

Empty workspaces

Keep one empty destination for dragging without showing every unused workspace:

sweets.overview({ empty = "one" })

Overview shows populated workspaces and one available empty workspace per monitor. If your selected workspace is empty, it is that tile.

What the tiles show

Tiles show live windows in their workspace layout. Monocle and tab groups show only the selected window. Special workspaces are left out, and opening Overview hides them until you reopen them.

With tile = "wallpaper", each monitor uses its own wallpaper. Panels stay above the grid. Tiles skip blur and most window animations. Moves and resizes animate with animations.window_move.

Screenshots and screen sharing of a monitor include its Overview tiles. Capture-blocking rules still apply. Sharing a single window keeps its normal size.

On this page