Skip to content

Commit

Permalink
Add new kscreenlocker appearance options (#298)
Browse files Browse the repository at this point in the history
  • Loading branch information
@HeitorAugustoLN
HeitorAugustoLN authored Aug 6, 2024
1 parent 61d9342 commit 1b94895
Showing 1 changed file with 77 additions and 44 deletions.
121 changes: 77 additions & 44 deletions modules/kscreenlocker.nix
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,67 @@ let
in
{
options.programs.plasma.kscreenlocker = {
wallpaper = lib.mkOption {
type = with lib.types; nullOr path;
default = null;
example = lib.literalExpression ''"''${pkgs.kdePackages.plasma-workspace-wallpapers}/share/wallpapers/Kay/contents/images/1080x1920.png"'';
description = ''
The wallpaper for the lockscreen. Can be either be the path to an image file or a kpackage.
'';
};
wallpaperPictureOfTheDay = lib.mkOption {
type = lib.types.nullOr wallpaperPictureOfTheDayType;
default = null;
example = { provider = "apod"; };
description = ''
Allows you to set wallpaper using the picture of the day plugin. Needs the provider.
'';
};
wallpaperSlideShow = lib.mkOption {
type = lib.types.nullOr wallpaperSlideShowType;
default = null;
example = lib.literalExpression ''{ path = "''${pkgs.kdePackages.plasma-workspace-wallpapers}/share/wallpapers/"; }'';
description = ''
Allows you to set wallpaper using the slideshow plugin. Needs the path
to at least one directory.
'';
};
wallpaperPlainColor = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = null;
example = "0,64,174,256";
description = ''
Allows you to set wallpaper using a plain color. Color is a comma-seperated R,G,B,A string. Alpha optional (default is 256).
'';
appearance = {
alwaysShowClock = lib.mkOption {
type = with lib.types; nullOr bool;
default = null;
example = false;
description = ''
Whether to always show the clock on the lockscreen, even if the unlock dialog is not shown.
'';
};
showMediaControls = lib.mkOption {
type = with lib.types; nullOr bool;
default = null;
example = false;
description = ''
Whether to show media controls on the lockscreen.
'';
};

wallpaper = lib.mkOption {
type = with lib.types; nullOr path;
default = null;
example = lib.literalExpression ''"''${pkgs.kdePackages.plasma-workspace-wallpapers}/share/wallpapers/Kay/contents/images/1080x1920.png"'';
description = ''
The wallpaper for the lockscreen. Can be either be the path to an image file or a kpackage.
'';
};
wallpaperPictureOfTheDay = lib.mkOption {
type = lib.types.nullOr wallpaperPictureOfTheDayType;
default = null;
example = { provider = "apod"; };
description = ''
Allows you to set wallpaper using the picture of the day plugin. Needs the provider.
'';
};
wallpaperSlideShow = lib.mkOption {
type = lib.types.nullOr wallpaperSlideShowType;
default = null;
example = lib.literalExpression ''{ path = "''${pkgs.kdePackages.plasma-workspace-wallpapers}/share/wallpapers/"; }'';
description = ''
Allows you to set wallpaper using the slideshow plugin. Needs the path
to at least one directory.
'';
};
wallpaperPlainColor = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = null;
example = "0,64,174,256";
description = ''
Allows you to set wallpaper using a plain color. Color is a comma-seperated R,G,B,A string. Alpha optional (default is 256).
'';
};
};
};

imports = [
(lib.mkRenamedOptionModule ["programs" "plasma" "kscreenlocker" "wallpaper"] ["programs" "plasma" "kscreenlocker" "appearance" "wallpaper"])
(lib.mkRenamedOptionModule ["programs" "plasma" "kscreenlocker" "wallpaperPictureOfTheDay"] ["programs" "plasma" "kscreenlocker" "appearance" "wallpaperPictureOfTheDay"])
(lib.mkRenamedOptionModule ["programs" "plasma" "kscreenlocker" "wallpaperSlideShow"] ["programs" "plasma" "kscreenlocker" "appearance" "wallpaperSlideShow"])
(lib.mkRenamedOptionModule ["programs" "plasma" "kscreenlocker" "wallpaperPlainColor"] ["programs" "plasma" "kscreenlocker" "appearance" "wallpaperPlainColor"])
];

config = {
assertions = [
{
Expand All @@ -52,31 +78,38 @@ in
}
];
programs.plasma.configFile.kscreenlockerrc = (lib.mkMerge [
(lib.mkIf (cfg.kscreenlocker.wallpaper != null) {
(lib.mkIf (cfg.kscreenlocker.appearance.wallpaper != null) {
Greeter.WallpaperPlugin = "org.kde.image";
"Greeter/Wallpaper/org.kde.image/General".Image = (builtins.toString cfg.kscreenlocker.wallpaper);
"Greeter/Wallpaper/org.kde.image/General".Image = (builtins.toString cfg.kscreenlocker.appearance.wallpaper);
})
(lib.mkIf (cfg.kscreenlocker.wallpaperPictureOfTheDay != null) {
(lib.mkIf (cfg.kscreenlocker.appearance.wallpaperPictureOfTheDay != null) {
Greeter.WallpaperPlugin = "org.kde.potd";
"Greeter/Wallpaper/org.kde.potd/General" = {
Provider = cfg.kscreenlocker.wallpaperPictureOfTheDay.provider;
UpdateOverMeteredConnection = with cfg.kscreenlocker.wallpaperPictureOfTheDay;
Provider = cfg.kscreenlocker.appearance.wallpaperPictureOfTheDay.provider;
UpdateOverMeteredConnection = with cfg.kscreenlocker.appearance.wallpaperPictureOfTheDay;
(lib.mkIf (updateOverMeteredConnection != null) (if updateOverMeteredConnection then 1 else 0));
};
})
(lib.mkIf (cfg.kscreenlocker.wallpaperSlideShow != null) {
(lib.mkIf (cfg.kscreenlocker.appearance.wallpaperSlideShow != null) {
Greeter.WallpaperPlugin = "org.kde.slideshow";
"Greeter/Wallpaper/org.kde.slideshow/General" = {
SlidePaths = with cfg.kscreenlocker.wallpaperSlideShow;
SlidePaths = with cfg.kscreenlocker.appearance.wallpaperSlideShow;
(if ((builtins.isPath path) || (builtins.isString path)) then
(builtins.toString cfg.kscreenlocker.wallpaperSlideShow.path) else
(builtins.concatStringsSep "," cfg.kscreenlocker.wallpaperSlideShow.path));
SlideInterval = cfg.kscreenlocker.wallpaperSlideShow.interval;
(builtins.toString cfg.kscreenlocker.appearance.wallpaperSlideShow.path) else
(builtins.concatStringsSep "," cfg.kscreenlocker.appearance.wallpaperSlideShow.path));
SlideInterval = cfg.kscreenlocker.appearance.wallpaperSlideShow.interval;
};
})
(lib.mkIf (cfg.kscreenlocker.wallpaperPlainColor != null) {
(lib.mkIf (cfg.kscreenlocker.appearance.wallpaperPlainColor != null) {
Greeter.WallpaperPlugin = "org.kde.color";
"Greeter/Wallpaper/org.kde.color/General".Color = cfg.kscreenlocker.wallpaperPlainColor;
"Greeter/Wallpaper/org.kde.color/General".Color = cfg.kscreenlocker.appearance.wallpaperPlainColor;
})

(lib.mkIf (cfg.kscreenlocker.appearance.alwaysShowClock != null) {
"Greeter/LnF/General".alwaysShowClock = cfg.kscreenlocker.appearance.alwaysShowClock;
})
(lib.mkIf (cfg.kscreenlocker.appearance.showMediaControls != null) {
"Greeter/LnF/General".showMediaControls = cfg.kscreenlocker.appearance.showMediaControls;
})
]);
};
Expand Down

0 comments on commit 1b94895

Please sign in to comment.