Hyprtasking

Powerful workspace management plugin, packed with features.

Important

• Supports Hyprland release v0.46.2.
• Support for Hyprland-git HAS BEEN DROPPED until the rendering rewrite is more mature!! If you'd still like to use it, build from the git-archive branch.

demo_small.mp4

Jump To Installation

See Configuration

Roadmap

• Modular Layouts
  • Grid layout
  • Linear layout
  • Minimap layout
• Mouse controls
  • Exit into workspace (hover, click)
  • Drag and drop windows
• Keyboard controls
  • Switch workspaces with direction
  • Switch workspaces with absolute number
• Multi-monitor support (tested)
• Monitor scaling support (tested)
• Animation support
• Configurability
  • Overview exit behavior
  • Number of visible workspaces
  • Custom workspace layouts
  • Toggle behavior
  • Toggle keybind
• Touch and gesture support

Installation

Hyprpm

hyprpm add https://github.com/raybbian/hyprtasking
hyprpm enable hyprtasking

Nix

Add hyprtasking to your flake inputs

# flake.nix
{
  inputs = {
    hyprland.url = "github:hyprwm/Hyprland/v0.46.2";

    hyprtasking = {
      url = "github:raybbian/hyprtasking";
      inputs.hyprland.follows = "hyprland";
    };
  };
  # ...
}

Include the plugin in the hyprland home manager options

# home.nix
{ inputs, ... }:
{
  wayland.windowManager.hyprland = {
    plugins = [
      inputs.hyprtasking.packages.${pkgs.system}.hyprtasking
    ];
  }
}

Manual

To build, have hyprland headers installed on the system and then:

meson setup build
cd build && meson compile

Then use hyprctl plugin load to load the absolute path to the .so file.

Usage

Opening Overview

• Bind hyprtasking:toggle, all to a keybind to open/close the overlay on all monitors.
• See below for configuration options.

Interaction

• Workspace Transitioning:
  • Open the overlay, then use right click to switch to a workspace
  • Use the directional dispatchers hyprtasking:move to switch to a workspace
• Window management:
  • Left click to drag and drop windows around

Configuration

Example below:

bind = $mainMod, tab, hyprtasking:toggle, cursor
bind = $mainMod, space, hyprtasking:toggle, all

bind = $mainMod, X, hyprtasking:killhovered

bind = $mainMod, H, hyprtasking:move, left
bind = $mainMod, J, hyprtasking:move, down
bind = $mainMod, K, hyprtasking:move, up
bind = $mainMod, L, hyprtasking:move, right

plugin {
    hyprtasking {
        layout = linear

        gap_size = 20
        bg_color = $overlay
        border_size = 4
        exit_behavior = active hovered interacted original

        gaps {
            rows = 3
        }
        linear {
            height = 300
            scroll_speed = 1.1;
        }
    }
}

Dispatchers

• hyprtasking:toggle, ARG takes in 1 argument that is either cursor or all

  • if the argument is all, then
    • if all overviews are hidden, then all overviews will be shown
    • otherwise all overviews will be hidden
  • if the argument is cursor, then
    • if current monitor's overview is hidden, then it will be shown
    • otherwise all overviews will be hidden

• hyprtasking:move, ARG takes in 1 argument that is one of up, down, left, right

  • when dispatched, hyprtasking will switch workspaces with a nice animation

• hyprtasking:killhovered behaves similarly to the standard killactive dispatcher with focus on hover

  • when dispatched, hyprtasking will the currently hovered window, useful when the overview is active.
  • this dispatcher is designed to replace killactive, it will work even when the overview is not active.

Config Options

• plugin:hyprtasking:layout (str): The layout to use. This is either 'grid' or 'linear'.

• plugin:hyprtasking:gap_size (int): The width (logical pixels) of the vertical gaps between workspaces

• plugin:hyprtasking:bg_color (color): The background color that does not include

• plugin:hyprtasking:border_size (int): The width (logical pixels) of the borders around workspaces

• plugin:hyprtasking:exit_behavior (str): A space-separated list of {'hovered', 'active', interacted', 'original'}

  • When an overview is about to hide, hyprtasking will evaluate these strings in order
    • If the string is 'hovered', hyprtasking will attempt to switch to the hovered workspace
    • If the string is 'interacted', hyprtasking will attempt to switch to the last interacted workspace (window drag/drop)
    • If the string is 'original', hyprtasking will attempt to switch to the workspace in which the overview was shown initially
    • (Fallback) If the string is 'active', hyprtasking will switch to the monitor's active workspace.

Grid Layout

• plugin:hyprtasking:grid:rows (int): The number of rows (and columns) of workspaces to show

Linear Layout

• plugin:hyprtasking:linear:height (int): The height of the workspace try in logical pixels.

• plugin:hyprtasking:linear:scroll_speed (float): The scroll speed multiplier (use negative value to reverse scrolling).