VOOZH about

URL: https://wiki.archlinux.org/title/Hyprlock

⇱ Hyprlock - ArchWiki


Jump to content
From ArchWiki

Related articles

Hyprlock is Hyprland's screen locker. It is highly customizable.

Installation

Install the hyprlock package.

Configuration

Configuration is done through the hyprlock.conf file in ~/.config/hypr.

Note Hyprlock does not generate a configuration file on installation, and will not run without one.

Widgets

Hyprlock works on a widget-based system. Widgets can be created with the following format:

~/.config/hypr/hyprlock.conf
widget {
 property = value
 ...
}
Note As many of these can be put in the hyprlock.conf file as desired. For example:
~/.config/hypr/hyprlock.conf
label {
 ...
}
label {
 ...
}
input-field {
 ...
}

Examples

The background of Hyprlock:

~/.config/hypr/hyprlock.conf
background {
 monitor = # monitor-agnostic
 path = ~/Pictures/mountain.jpg
 blur_passes = 1
 blur_size = 7
}

An input field for the password:

~/.config/hypr/hyprlock.conf
input-field {
 monitor =
 size = 20%, 5%
 font_family = Noto Sans
 dots_size = 0.08
}

A label that displays the time:

~/.config/hypr/hyprlock.conf
label {
 monitor =
 text = $TIME
 font_size = 100
 position = 0, -80
}

The $TIME that comes after text can be substituted for any other text, $USER, $FAIL, and $TIME12, among others.