A Wayland layer-shell logout prompt, now ported to GTK4!

A fork of wlogout with a bunch of quality-of-life features.

wleave can be installed from the AUR:

paru -S wleave-git

Dependencies:

• gtk4-layer-shell
• gtk4
• librsvg (for SVG images)
• libadwaita
• a stable version of the Rust toolchain

You can run the application using cargo run --release or GNU make:

make
./target/release/wleave

The command line options are backwards-compatible with wlogout. See --help for a list of options.

The <Esc> key closes the menu, an option to change this may be added eventually.

wleave is backwards-compatible with wlogout configuration files.

Since version 0.6.0, full JSON configuration can be used in place of the wlogout-based configuration. The default configuration file can be copied from /etc/wleave/layout.json. The new configuration system is more flexible as it removes the need for extra command-line arguments.

From man 5 wleave.json, the allowed top-level options are:

• "buttons" (array) - a list of buttons
• "css" (string) - Specify a custom CSS file instead of the default one
• "buttons-per-row": "3" (string) Set the number of buttons per row, or use a fraction to specify the number of rows to be used (e.g. "1/1" for all buttons in a single row, "1/5" to distribute the buttons over 5 rows)
• "column-spacing": 8 (number) Set space between buttons columns
• "row-spacing": 8 (number) Set space between buttons rows
• "margin": 200 (number) Set margin on all sides
• "margin-left" (number) Set margin for left of buttons. Falls back to the value set by margin
• "margin-right" (number) Set margin for right of buttons. Falls back to the value set by margin
• "margin-top" (number) Set margin for top of buttons. Falls back to the value set by margin
• "margin-bottom" (number) Set margin for bottom of buttons. Falls back to the value set by margin
• "close-on-lost-focus": false (boolean) Closes the menu if focus is lost
• "show-keybinds": false: (boolean) Show the associated key binds for each button
• "protocol": "layer-shell" ("layer-shell"/"xdg") Backend to use for full-screening the menu
• "no-version-info": false (boolean) Hides the version label.
• "delay-command-ms": 100 (number) The number of milliseconds to wait after an action before the associated command is executed

The command-line option counterparts of these options take precedence over the configuration file.

Example configuration with one button that executes swaylock on click:

{
    "margin": 200,
    "buttons-per-row": "1/1",
    "delay-command-ms": 100,
    "close-on-lost-focus": true,
    "show-keybinds": true,
    "buttons": [
        {
            "label": "lock",
            "action": "swaylock",
            "text": "Lock",
            "keybind": "l",
            "icon": "/usr/share/wleave/icons/lock.svg"
        }
    ]
}

Layout files may also be read from stdin with --layout -. For example, with jq, buttons can be picked out:

$ jq '.buttons[] |= select([.label] | inside(["lock", "logout"]))' layout.json | wleave --layout -

By default, wleave follows libadwaita colors and uses CSS variables. This allows following the system light/dark theme preference from GNOME settings. In other desktop environments, this may be changed with gsettings set org.gnome.desktop.interface color-scheme "'prefer-dark'" or gsettings set org.gnome.desktop.interface color-scheme "'prefer-light'" correspondingly.

The stylesheet in /etc/wleave/style.css is fully customizable and can be edited.

SVG icons are dynamically recolored if possible. (since 0.6.2)

Each button has an identifier set in the layout file, which allows custom-styling each button one-by-one. Icon colors may be changed by modifying the CSS variable --view-fg-color, or by setting a custom color property entirely.

Example stylesheet that makes the selected icon colored with the libadwaita accent color:

window {
    background-color: rgba(12, 12, 12, 0.8);
}

button {
    color: var(--view-fg-color);
    background-color: var(--view-bg-color);
    border: none;
    padding: 10px;
}

button label.action-name {
    font-size: 24px;
}

button label.keybind {
    font-size: 20px;
    font-family: monospace;
}

button:hover label.keybind, button:focus label.keybind {
    opacity: 1;
}

button:hover,
button:focus {
    color: var(--accent-color);
    background-color: var(--window-bg-color);
}

button:active {
    color: var(--accent-fg-color);
    background-color: var(--accent-bg-color);
}

See https://gitlab.gnome.org/GNOME/gtk/-/blob/4.18.0/gdk/keynames.txt for a list of valid keybinds.

• SVG icons can be colorized via CSS color
• Libadwaita accent colors
• Automatic light theme by default since 0.6
• Natively GTK4 since version 0.5
• New pretty icons by @earth-walker
• Autoclose when window focus is lost (the -f/--close-on-lost-focus flag)
• Mnemonic labels (the -k/--show-keybinds flag)
• Pretty gaps by default
• Less error-prone
• Keybinds accept modifier keys and Unicode characters
• Easier to extend