hypr-dock

Interactive Dock Panel for Hyprland

Translations: Русский

Installation

Dependencies

• go (make)
• gtk3
• gtk-layer-shell

Install

git clone https://github.com/lotos-linux/hypr-dock.git
cd hypr-dock
make get
make build
make install

Uninstall

make uninstall

Update

make update

Local run (dev mode)

make exec

Launching

Launch Parameters:

-config string
    config file (default "~/.config/hypr-dock")
-dev
    enable developer mode
-theme string
    theme dir (default "lotos")

All parameters are optional.

The default configuration and themes are installed in ~/.config/hypr-dock

Add the following to hyprland.conf for autostart:

exec-once = hypr-dock
bind = Super, D, exec, hypr-dock

The dock supports only one running instance, so launching it again will close the previous instance.

Configuration

The following parameters are available in config.jsonc:

{
    "CurrentTheme": "lotos",

    // Icon size (px) (default 23)
    "IconSize": 23,

    // Window overlay layer height (auto, exclusive-top, exclusive-bottom, background, bottom, top, overlay) (default "auto")
    "Layer": "auto",

    // Window position on screen (top, bottom, left, right) (default "bottom")
    "Position": "bottom",

    // Delay before hiding the dock (ms) (default 400)
    "AutoHideDeley": 400, // *Only for "Layer": "auto"*

    // Use system gap (true, false) (default "true")
    "SystemGapUsed": "true",

    // Indent from the edge of the screen (px) (default 8)
    "Margin": 8,

    // Distance of the context menu from the window (px) (default 0)
    "ContextPos": 5,

    
    // Window thumbnail mode selection (none, live, static) (default "none")
    "Preview": "static",
    /*
      "none"   - disabled (text menus)
      "static" - last window frame (stable)
      "live"   - window streaming (unstable) !EXPEREMENTAL!
      
      !WARNING! 
      BY SETTING "Preview" TO "live" OR "static", YOU AGREE TO THE CAPTURE 
      OF WINDOW CONTENTS.
      THE "HYPR-DOCK" PROGRAM DOES NOT COLLECT, STORE, OR TRANSMIT ANY DATA.
      WINDOW CAPTURE OCCURS ONLY FOR THE DURATION OF THE THUMBNAIL DISPLAY!
      
      Source code: https://github.com/lotos-linux/hypr-dock
    */

    "PreviewAdvanced": {
      // Live preview fps (0 - ∞) (default 30)
      "FPS": 30,

      // Live preview bufferSize (1 - 20) (default 5)
      "BufferSize": 5,

      // Popup show/hide/move delays (ms)
      "ShowDelay": 600, // (default 600)
      "HideDelay": 300, // (default 300)
      "MoveDelay": 200  // (default 200)
    }
}

If a parameter is not specified, the default value will be used.

Explanation of Non-Obvious Parameters

Layer

• With "Layer": "auto" the dock layer is below all windows, but if you move the mouse cursor to the edge of the screen, the dock rises above them.
• With "Layer": "exclusive-top" - exclusive mode is enabled on the top layer. Neither tiled nor floating windows will overlap the dock.
• With "Layer": "exclusive-bottom" - exclusive mode is enabled on the bottom layer. Tiled windows won't overlap the dock. Floating windows will appear above the dock.

SystemGapUsed

• With "SystemGapUsed": "true" the dock will set its margin from the edge of the screen based on the hyprland configuration, specifically the general:gaps_out value. The dock will dynamically adapt to changes in the hyprland configuration.
• With "SystemGapUsed": "false" the margin from the edge of the screen will be set by the Margin parameter.

PreviewAdvanced

• ShowDelay, HideDelay, MoveDelay - delays for preview popup actions in milliseconds.
• FPS, BufferSize - only used with "Preview":"live"

Warning! Live preview behaves unpredictably. Currently, it is not recommended to set "Preview": "live"

Настройки внешнего вида превью происхрдит через файлы темы

There is also a pinned.json file for pinned applications

Example:

{
  "Pinned": [
    "firefox",
    "org.telegram.desktop",
    "code-oss",
    "kitty"
  ]
}

You can edit it manually. But why? ¯_(ツ)_/¯

Themes

Themes are located in the ~/.config/hypr-dock/themes/ folder

A theme consists of:

• [theme_name].jsonc, for example lotos.jsonc
• style.css
• A folder with svg files for indicating the number of running applications (more themes.md)

Theme Config

{
    // Blur window ("true", "false") (default "on")
    "Blur": "true",

    // Distance between elements (px) (default 9)
    "Spacing": 5,

    // Preview settings
    "PreviewStyle": {
        // Size (px) (default 120)
        "Size": 120,

        // Image/Stream border-radius (px) (default 0)
        "BorderRadius": 0,

        // Popup padding (px) (default 10)
        "Padding": 10
    }
}

Feel free to customize the style.css file as you like.

Libraries Used

• github.com/akshaybharambe14/go-jsonc v1.0.0
• github.com/allan-simon/go-singleinstance v0.0.0-20210120080615-d0997106ab37
• github.com/dlasky/gotk3-layershell v0.0.0-20240515133811-5c5115f0d774
• github.com/goccy/go-json v0.10.3
• github.com/gotk3/gotk3 v0.6.3