Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.hyprlock.enable

Whether to enable Hyprlock, Hyprland’s GPU-accelerated lock screen utility.

Note that PAM must be configured to enable hyprlock to perform authentication. The package installed through home-manager will not be able to unlock the session without this configuration.

On NixOS, it can be enabled using:

security.pam.services.hyprlock = {};

Type: boolean

Default:

false

Example:

true

Declared by:

programs.hyprlock.package

The hyprlock package to use.

Type: null or package

Default:

pkgs.hyprlock

Declared by:

programs.hyprlock.extraConfig

Extra configuration lines to add to ~/.config/hypr/hyprlock.conf.

Type: strings concatenated with “\n”

Default:

""

Declared by:

programs.hyprlock.importantPrefixes

List of prefix of attributes to source at the top of the config.

Type: list of string

Default:

[
  "$"
  "bezier"
  "monitor"
  "size"
]

Declared by:

programs.hyprlock.settings

Hyprlock configuration written in Nix. Entries with the same key should be written as lists. Variables’ and colors’ names should be quoted. See https://wiki.hypr.land/Hypr-Ecosystem/hyprlock/ for more examples.

Type: Hyprlock configuration value

Default:

{ }

Example:

{
  general = {
    hide_cursor = true;
    ignore_empty_input = true;
  };

  animations = {
    enabled = true;
    fade_in = {
      duration = 300;
      bezier = "easeOutQuint";
    };
    fade_out = {
      duration = 300;
      bezier = "easeOutQuint";
    };
  };

  background = [
    {
      path = "screenshot";
      blur_passes = 3;
      blur_size = 8;
    }
  ];

  input-field = [
    {
      size = "200, 50";
      position = "0, -80";
      monitor = "";
      dots_center = true;
      fade_on_empty = false;
      font_color = "rgb(202, 211, 245)";
      inner_color = "rgb(91, 96, 120)";
      outer_color = "rgb(24, 25, 38)";
      outline_thickness = 5;
      placeholder_text = '\'<span foreground="##cad3f5">Password...</span>'\';
      shadow_passes = 2;
    }
  ];
}

Declared by:

programs.hyprlock.sourceFirst

Whether to enable putting source entries at the top of the configuration.

Type: boolean

Default:

true

Example:

true

Declared by: