{ config, options, lib, pkgs, ... }: with lib; let cfg = config.services.polybar; opt = options.services.polybar; eitherStrBoolIntList = with types; either str (either bool (either int (listOf str))); # Convert a key/val pair to the insane format that polybar uses. # Each input key/val pair may return several output key/val pairs. convertPolybarKeyVal = key: val: # Convert { foo = [ "a" "b" ]; } # to { # foo-0 = "a"; # foo-1 = "b"; # } if isList val then concatLists (imap0 (i: convertPolybarKeyVal "${key}-${toString i}") val) # Convert { # foo.text = "a"; # foo.font = 1; # } to { # foo = "a"; # foo-font = 1; # } else if isAttrs val && !lib.isDerivation val then concatLists (mapAttrsToList (k: convertPolybarKeyVal (if k == "text" then key else "${key}-${k}")) val) # Base case else [ (nameValuePair key val) ]; convertPolybarSection = _: attrs: listToAttrs (concatLists (mapAttrsToList convertPolybarKeyVal attrs)); # Converts an attrset to INI text, quoting values as expected by polybar. # This does no more fancy conversion. toPolybarIni = generators.toINI { mkKeyValue = key: value: let quoted = v: if hasPrefix " " v || hasSuffix " " v then ''"${v}"'' else v; value' = if isBool value then (if value then "true" else "false") else if (isString value && key != "include-file") then quoted value else toString value; in "${key}=${value'}"; }; configFile = let isDeclarativeConfig = cfg.settings != opt.settings.default || cfg.config != opt.config.default || cfg.extraConfig != opt.extraConfig.default; in if isDeclarativeConfig then pkgs.writeText "polybar.conf" '' ${toPolybarIni cfg.config} ${toPolybarIni (mapAttrs convertPolybarSection cfg.settings)} ${cfg.extraConfig} '' else null; in { options = { services.polybar = { enable = mkEnableOption (lib.mdDoc "Polybar status bar"); package = mkOption { type = types.package; default = pkgs.polybar; defaultText = literalExpression "pkgs.polybar"; description = lib.mdDoc "Polybar package to install."; example = literalExpression '' pkgs.polybar.override { i3GapsSupport = true; alsaSupport = true; iwSupport = true; githubSupport = true; } ''; }; config = mkOption { type = types.coercedTo types.path (p: { "section/base" = { include-file = "${p}"; }; }) (types.attrsOf (types.attrsOf eitherStrBoolIntList)); description = lib.mdDoc '' Polybar configuration. Can be either path to a file, or set of attributes that will be used to create the final configuration. See also {option}`services.polybar.settings` for a more nix-friendly format. ''; default = { }; example = literalExpression '' { "bar/top" = { monitor = "\''${env:MONITOR:eDP1}"; width = "100%"; height = "3%"; radius = 0; modules-center = "date"; }; "module/date" = { type = "internal/date"; internal = 5; date = "%d.%m.%y"; time = "%H:%M"; label = "%time% %date%"; }; } ''; }; settings = mkOption { type = with types; let ty = oneOf [ bool int float str (listOf ty) (attrsOf ty) ]; in attrsOf (attrsOf ty // { description = "attribute sets"; }); description = lib.mdDoc '' Polybar configuration. This takes a nix attrset and converts it to the strange data format that polybar uses. Each entry will be converted to a section in the output file. Several things are treated specially: nested keys are converted to dash-separated keys; the special `text` key is ignored as a nested key, to allow mixing different levels of nesting; and lists are converted to polybar's `foo-0, foo-1, ...` format. For example: ```nix "module/volume" = { type = "internal/pulseaudio"; format.volume = " "; label.muted.text = "🔇"; label.muted.foreground = "#666"; ramp.volume = ["🔈" "🔉" "🔊"]; click.right = "pavucontrol &"; } ``` becomes: ```ini [module/volume] type=internal/pulseaudio format-volume= label-muted=🔇 label-muted-foreground=#666 ramp-volume-0=🔈 ramp-volume-1=🔉 ramp-volume-2=🔊 click-right=pavucontrol & ``` ''; default = { }; example = literalExpression '' { "module/volume" = { type = "internal/pulseaudio"; format.volume = " "; label.muted.text = "🔇"; label.muted.foreground = "#666"; ramp.volume = ["🔈" "🔉" "🔊"]; click.right = "pavucontrol &"; }; } ''; }; extraConfig = mkOption { type = types.lines; description = lib.mdDoc "Additional configuration to add."; default = ""; example = '' [module/date] type = internal/date interval = 5 date = "%d.%m.%y" time = %H:%M format-prefix-foreground = \''${colors.foreground-alt} label = %time% %date% ''; }; script = mkOption { type = types.lines; description = lib.mdDoc '' This script will be used to start the polybars. Set all necessary environment variables here and start all bars. It can be assumed that {command}`polybar` executable is in the {env}`PATH`. Note, this script must start all bars in the background and then terminate. ''; example = "polybar bar &"; }; }; }; config = mkIf cfg.enable { assertions = [ (lib.hm.assertions.assertPlatform "services.polybar" pkgs lib.platforms.linux) ]; meta.maintainers = with maintainers; [ h7x4 ]; home.packages = [ cfg.package ]; xdg.configFile."polybar/config.ini" = mkIf (configFile != null) { source = configFile; }; systemd.user.services.polybar = { Unit = { Description = "Polybar status bar"; PartOf = [ "tray.target" ]; X-Restart-Triggers = mkIf (configFile != null) "${configFile}"; }; Service = { Type = "forking"; Environment = "PATH=${cfg.package}/bin:/run/wrappers/bin"; ExecStart = let scriptPkg = pkgs.writeShellScriptBin "polybar-start" cfg.script; in "${scriptPkg}/bin/polybar-start"; Restart = "on-failure"; }; Install = { WantedBy = [ "tray.target" ]; }; }; }; }