hyprland-wiki/pages/Hypr Ecosystem/hyprlock.md

hyprlock is a simple, yet fast, multi-threaded and GPU-accelerated screen lock for hyprland.

{{< toc >}}

Configuration

Configuration is done via the config file at ~/.config/hypr/hyprlock.conf. It is not required, but recommended. Without it, locking shows the current screen.

General

Variables in the general category:

variable	description	type	default
disable_loading_bar	disables the loading bar on the bottom of the screen while hyprlock is booting up.	bool	false
hide_cursor	hides the cursor instead of making it visible	bool	true

Widgets

The entire configuration of how hyprlock looks is done via widgets.

widget_name {
    monitor =
    # further options
}

monitor can be left empty for "all monitors"

Widget List

General remarks

• All rendered text supports pango markup.
  • Additionally hyprlock will parse <br/> for your convenience. (That's a linebreak) Remember to enable linebreaks in your spans with allow_breaks="true".
• Positioning is done via halign, valign and position. Position is an added offset to the result of alignment.
  • halign: left, center, right, none. valign: top, center, bottom, none

Background

Draws a background image or fills with color.

If path is empty or missing, will use color. Otherwise, the image will be used.

background {
    monitor =
    path = /home/me/someImage.png   # only png supported for now
    color = rgba(25, 20, 20, 1.0)
}

Input Field

Draws a password input field.

input-field {
    monitor =
    size = 200, 50
    outline_thickness = 3
    dots_size = 0.33 # Scale of input-field height, 0.2 - 0.8
    dots_spacing = 0.15 # Scale of dots' absolute size, 0.0 - 1.0
    dots_center = false
    outer_color = rgb(151515)
    inner_color = rgb(200, 200, 200)
    font_color = rgb(10, 10, 10)
    fade_on_empty = true
    placeholder_text = <i>Input Password...</i> # Text rendered in the input box when it's empty.
    hide_input = false

    position = 0, -20
    halign = center
    valign = center
}

Label

Draws a label.

label {
    monitor =
    text = Hi there, $USER
    color = rgba(200, 200, 200, 1.0)
    font_size = 25
    font_family = Noto Sans

    position = 0, 80
    halign = center
    valign = center
}

Available variables for text:

• $USER - username
• $TIME - current time (e.g. 13:37)

text also supports launching commands, for example:

text = cmd[update:1000] echo "<span foreground='##ff2222'>$(date)</span>"

Worth noting:

• update: - time is in ms.
• Variables seen above are parsed before the command is ran.