home-manager/modules/programs/wlogout.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

149 lines
3.8 KiB
Nix

{ config, lib, pkgs, ... }:
let
inherit (lib) all filterAttrs isStorePath literalExpression types;
inherit (lib.options) mkEnableOption mkPackageOptionMD mkOption;
inherit (lib.modules) mkIf;
inherit (lib.strings) concatMapStrings;
inherit (builtins) toJSON;
cfg = config.programs.wlogout;
jsonFormat = pkgs.formats.json { };
wlogoutLayoutConfig = with types;
submodule {
freeformType = jsonFormat.type;
options = {
label = mkOption {
type = str;
default = "";
example = "shutdown";
description = lib.mdDoc "CSS label of button.";
};
action = mkOption {
type = either path str;
default = "";
example = "systemctl poweroff";
description = lib.mdDoc "Command to execute when clicked.";
};
text = mkOption {
type = str;
default = "";
example = "Shutdown";
description = lib.mdDoc "Text displayed on button.";
};
keybind = mkOption {
type = str;
default = "";
example = "s";
description = lib.mdDoc "Keyboard character to trigger this action.";
};
height = mkOption {
type = nullOr (numbers.between 0 1);
default = null;
example = 0.5;
description = lib.mdDoc "Relative height of tile.";
};
width = mkOption {
type = nullOr (numbers.between 0 1);
default = null;
example = 0.5;
description = lib.mdDoc "Relative width of tile.";
};
circular = mkOption {
type = nullOr bool;
default = null;
example = true;
description = lib.mdDoc "Make button circular.";
};
};
};
in {
meta.maintainers = [ lib.maintainers.Scrumplex ];
options.programs.wlogout = with lib.types; {
enable = mkEnableOption (lib.mdDoc "wlogout");
package = mkPackageOptionMD pkgs "wlogout" { };
layout = mkOption {
type = listOf wlogoutLayoutConfig;
default = [ ];
description = lib.mdDoc ''
Layout configuration for wlogout, see <https://github.com/ArtsyMacaw/wlogout#config>
for supported values.
'';
example = literalExpression ''
[
{
label = "shutdown";
action = "systemctl poweroff";
text = "Shutdown";
keybind = "s";
}
]
'';
};
style = mkOption {
type = nullOr (either path str);
default = null;
description = lib.mdDoc ''
CSS style of the bar.
See <https://github.com/ArtsyMacaw/wlogout#style>
for the documentation.
If the value is set to a path literal, then the path will be used as the css file.
'';
example = ''
window {
background: #16191C;
}
button {
color: #AAB2BF;
}
'';
};
};
config = let
# Removes nulls because wlogout ignores them.
# This is not recursive.
removeTopLevelNulls = filterAttrs (_: v: v != null);
cleanJSON = foo: toJSON (removeTopLevelNulls foo);
# wlogout doesn't want a JSON array, it just wants a list of JSON objects
layoutJsons = map cleanJSON cfg.layout;
layoutContent = concatMapStrings (l: l + "\n") layoutJsons;
in mkIf cfg.enable {
assertions = [
(lib.hm.assertions.assertPlatform "programs.wlogout" pkgs
lib.platforms.linux)
];
home.packages = [ cfg.package ];
xdg.configFile."wlogout/layout" = mkIf (cfg.layout != [ ]) {
source = pkgs.writeText "wlogout/layout" layoutContent;
};
xdg.configFile."wlogout/style.css" = mkIf (cfg.style != null) {
source = if builtins.isPath cfg.style || isStorePath cfg.style then
cfg.style
else
pkgs.writeText "wlogout/style.css" cfg.style;
};
};
}