2023-01-08 22:05:36 +01:00
|
|
|
|
{ config, lib, moduleName, cfg, pkgs, capitalModuleName ? moduleName }:
|
2019-09-04 04:30:44 +02:00
|
|
|
|
|
|
|
|
|
with lib;
|
|
|
|
|
|
|
|
|
|
let
|
2021-01-11 18:18:32 +01:00
|
|
|
|
isI3 = moduleName == "i3";
|
|
|
|
|
isSway = !isI3;
|
|
|
|
|
|
2023-01-08 22:05:36 +01:00
|
|
|
|
inherit (config.home) stateVersion;
|
|
|
|
|
|
2021-05-04 05:54:35 +02:00
|
|
|
|
fontOptions = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
names = mkOption {
|
|
|
|
|
type = types.listOf types.str;
|
|
|
|
|
default = [ "monospace" ];
|
2021-10-09 11:14:08 +02:00
|
|
|
|
defaultText = literalExpression ''[ "monospace" ]'';
|
2021-05-04 05:54:35 +02:00
|
|
|
|
description = ''
|
|
|
|
|
List of font names list used for window titles. Only FreeType fonts are supported.
|
|
|
|
|
The order here is important (e.g. icons font should go before the one used for text).
|
|
|
|
|
'';
|
2021-10-09 11:14:08 +02:00
|
|
|
|
example = literalExpression ''[ "FontAwesome" "Terminus" ]'';
|
2021-05-04 05:54:35 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
style = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
default = "";
|
|
|
|
|
description = ''
|
|
|
|
|
The font style to use for window titles.
|
|
|
|
|
'';
|
|
|
|
|
example = "Bold Semi-Condensed";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
size = mkOption {
|
|
|
|
|
type = types.float;
|
|
|
|
|
default = 8.0;
|
|
|
|
|
description = ''
|
|
|
|
|
The font size to use for window titles.
|
|
|
|
|
'';
|
|
|
|
|
example = 11.5;
|
|
|
|
|
};
|
|
|
|
|
};
|
2019-09-04 04:30:44 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
startupModule = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
command = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
description = "Command that will be executed on startup.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
always = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = false;
|
|
|
|
|
description = "Whether to run command on each ${moduleName} restart.";
|
|
|
|
|
};
|
2021-01-11 18:18:32 +01:00
|
|
|
|
} // optionalAttrs isI3 {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
notification = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = true;
|
|
|
|
|
description = ''
|
|
|
|
|
Whether to enable startup-notification support for the command.
|
|
|
|
|
See <option>--no-startup-id</option> option description in the i3 user guide.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
workspace = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description = ''
|
|
|
|
|
Launch application on a particular workspace. DEPRECATED:
|
2022-08-26 00:07:08 +02:00
|
|
|
|
Use <xref linkend="opt-xsession.windowManager.i3.config.assigns"/>
|
2020-10-19 21:20:37 +02:00
|
|
|
|
instead. See <link xlink:href="https://github.com/nix-community/home-manager/issues/265"/>.
|
2019-09-04 04:30:44 +02:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
barModule = types.submodule {
|
2020-07-13 13:31:55 +02:00
|
|
|
|
options = let
|
2023-01-08 22:05:36 +01:00
|
|
|
|
versionAtLeast2009 = versionAtLeast stateVersion "20.09";
|
2020-07-13 13:31:55 +02:00
|
|
|
|
mkNullableOption = { type, default, ... }@args:
|
2021-05-06 00:12:48 +02:00
|
|
|
|
mkOption (args // {
|
2020-07-13 13:31:55 +02:00
|
|
|
|
type = types.nullOr type;
|
2021-05-06 00:12:48 +02:00
|
|
|
|
default = if versionAtLeast2009 then null else default;
|
2021-10-09 11:14:08 +02:00
|
|
|
|
defaultText = literalExpression ''
|
2021-05-06 00:12:48 +02:00
|
|
|
|
null for state version ≥ 20.09, as example otherwise
|
2020-07-13 13:31:55 +02:00
|
|
|
|
'';
|
2021-05-06 00:12:48 +02:00
|
|
|
|
example = default;
|
2020-07-13 13:31:55 +02:00
|
|
|
|
});
|
|
|
|
|
in {
|
2021-05-04 05:54:35 +02:00
|
|
|
|
fonts = mkOption {
|
|
|
|
|
type = with types; either (listOf str) fontOptions;
|
|
|
|
|
default = { };
|
2021-10-09 11:14:08 +02:00
|
|
|
|
example = literalExpression ''
|
2021-05-04 16:31:37 +02:00
|
|
|
|
{
|
|
|
|
|
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
|
|
|
|
style = "Bold Semi-Condensed";
|
|
|
|
|
size = 11.0;
|
|
|
|
|
}
|
|
|
|
|
'';
|
|
|
|
|
description = "Font configuration for this bar.";
|
2021-05-04 05:54:35 +02:00
|
|
|
|
};
|
2019-09-04 04:30:44 +02:00
|
|
|
|
|
|
|
|
|
extraConfig = mkOption {
|
|
|
|
|
type = types.lines;
|
|
|
|
|
default = "";
|
|
|
|
|
description = "Extra configuration lines for this bar.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
id = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description = ''
|
|
|
|
|
Specifies the bar ID for the configured bar instance.
|
|
|
|
|
If this option is missing, the ID is set to bar-x, where x corresponds
|
|
|
|
|
to the position of the embedding bar block in the config file.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
mode = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.enum [ "dock" "hide" "invisible" ];
|
|
|
|
|
default = "dock";
|
|
|
|
|
description = "Bar visibility mode.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
hiddenState = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.enum [ "hide" "show" ];
|
|
|
|
|
default = "hide";
|
|
|
|
|
description = "The default bar mode when 'bar.mode' == 'hide'.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
position = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.enum [ "top" "bottom" ];
|
|
|
|
|
default = "bottom";
|
|
|
|
|
description = "The edge of the screen ${moduleName}bar should show up.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
workspaceButtons = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.bool;
|
|
|
|
|
default = true;
|
|
|
|
|
description = "Whether workspace buttons should be shown or not.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
workspaceNumbers = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.bool;
|
|
|
|
|
default = true;
|
|
|
|
|
description =
|
|
|
|
|
"Whether workspace numbers should be displayed within the workspace buttons.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
command = mkOption {
|
|
|
|
|
type = types.str;
|
2021-01-11 18:26:18 +01:00
|
|
|
|
default = let
|
|
|
|
|
# If the user uses the "system" Sway (i.e. cfg.package == null) then the bar has
|
|
|
|
|
# to come from a different package
|
|
|
|
|
pkg = if isSway && isNull cfg.package then pkgs.sway else cfg.package;
|
|
|
|
|
in "${pkg}/bin/${moduleName}bar";
|
2019-09-04 04:30:44 +02:00
|
|
|
|
defaultText = "i3bar";
|
|
|
|
|
description = "Command that will be used to start a bar.";
|
2021-01-11 18:18:32 +01:00
|
|
|
|
example = if isI3 then
|
2023-01-08 22:05:36 +01:00
|
|
|
|
"\${pkgs.i3}/bin/i3bar -t"
|
2019-09-04 04:30:44 +02:00
|
|
|
|
else
|
|
|
|
|
"\${pkgs.waybar}/bin/waybar";
|
|
|
|
|
};
|
|
|
|
|
|
2021-05-06 00:12:48 +02:00
|
|
|
|
statusCommand = mkNullableOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
default = "${pkgs.i3status}/bin/i3status";
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = "Command that will be used to get status lines.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
colors = mkOption {
|
|
|
|
|
type = types.submodule {
|
|
|
|
|
options = {
|
2020-07-13 13:31:55 +02:00
|
|
|
|
background = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.str;
|
|
|
|
|
default = "#000000";
|
|
|
|
|
description = "Background color of the bar.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
statusline = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.str;
|
|
|
|
|
default = "#ffffff";
|
|
|
|
|
description = "Text color to be used for the statusline.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
separator = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.str;
|
|
|
|
|
default = "#666666";
|
|
|
|
|
description = "Text color to be used for the separator.";
|
|
|
|
|
};
|
|
|
|
|
|
2021-06-23 04:56:41 +02:00
|
|
|
|
focusedBackground = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description =
|
|
|
|
|
"Background color of the bar on the currently focused monitor output.";
|
|
|
|
|
example = "#000000";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
focusedStatusline = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description =
|
|
|
|
|
"Text color to be used for the statusline on the currently focused monitor output.";
|
|
|
|
|
example = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
focusedSeparator = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description =
|
|
|
|
|
"Text color to be used for the separator on the currently focused monitor output.";
|
|
|
|
|
example = "#666666";
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
focusedWorkspace = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = barColorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#4c7899";
|
|
|
|
|
background = "#285577";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
Border, background and text color for a workspace button when the workspace has focus.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
activeWorkspace = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = barColorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#5f676a";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
Border, background and text color for a workspace button when the workspace is active.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
inactiveWorkspace = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = barColorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#222222";
|
|
|
|
|
text = "#888888";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
Border, background and text color for a workspace button when the workspace does not
|
|
|
|
|
have focus and is not active.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
urgentWorkspace = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = barColorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#2f343a";
|
|
|
|
|
background = "#900000";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
Border, background and text color for a workspace button when the workspace contains
|
|
|
|
|
a window with the urgency hint set.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
bindingMode = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = barColorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#2f343a";
|
|
|
|
|
background = "#900000";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
description =
|
|
|
|
|
"Border, background and text color for the binding mode indicator";
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
default = { };
|
|
|
|
|
description = ''
|
|
|
|
|
Bar color settings. All color classes can be specified using submodules
|
|
|
|
|
with 'border', 'background', 'text', fields and RGB color hex-codes as values.
|
|
|
|
|
See default values for the reference.
|
|
|
|
|
Note that 'background', 'status', and 'separator' parameters take a single RGB value.
|
|
|
|
|
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#_colors"/>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-07-13 13:31:55 +02:00
|
|
|
|
trayOutput = mkNullableOption {
|
2019-09-04 04:30:44 +02:00
|
|
|
|
type = types.str;
|
|
|
|
|
default = "primary";
|
|
|
|
|
description = "Where to output tray.";
|
|
|
|
|
};
|
2023-04-17 01:34:29 +02:00
|
|
|
|
|
|
|
|
|
trayPadding = mkNullableOption {
|
|
|
|
|
type = types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = ''
|
|
|
|
|
Sets the pixel padding of the system tray.
|
|
|
|
|
This padding will surround the tray on all sides and between each item.
|
|
|
|
|
'';
|
|
|
|
|
};
|
2019-09-04 04:30:44 +02:00
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
barColorSetModule = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
border = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
background = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
text = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
colorSetModule = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
border = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
childBorder = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
background = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
text = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
indicator = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
visible = false;
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
windowCommandModule = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
command = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
description = "${capitalModuleName}wm command to execute.";
|
|
|
|
|
example = "border pixel 1";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
criteria = mkOption {
|
|
|
|
|
type = criteriaModule;
|
2021-08-22 02:41:06 +02:00
|
|
|
|
description = ''
|
|
|
|
|
Criteria of the windows on which command should be executed.
|
|
|
|
|
</para><para>
|
|
|
|
|
A value of <literal>true</literal> is equivalent to using an empty
|
|
|
|
|
criteria (which is different from an empty string criteria).
|
|
|
|
|
'';
|
2021-10-09 11:14:08 +02:00
|
|
|
|
example = literalExpression ''
|
2021-08-22 02:41:06 +02:00
|
|
|
|
{
|
|
|
|
|
title = "x200: ~/work";
|
|
|
|
|
floating = true;
|
|
|
|
|
};
|
|
|
|
|
'';
|
2019-09-04 04:30:44 +02:00
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
2021-08-22 02:41:06 +02:00
|
|
|
|
criteriaModule = types.attrsOf (types.either types.str types.bool);
|
2019-09-04 04:30:44 +02:00
|
|
|
|
in {
|
2021-05-04 05:54:35 +02:00
|
|
|
|
fonts = mkOption {
|
|
|
|
|
type = with types; either (listOf str) fontOptions;
|
|
|
|
|
default = { };
|
2021-10-09 11:14:08 +02:00
|
|
|
|
example = literalExpression ''
|
2021-05-04 16:31:37 +02:00
|
|
|
|
{
|
|
|
|
|
names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
|
|
|
|
|
style = "Bold Semi-Condensed";
|
|
|
|
|
size = 11.0;
|
|
|
|
|
}
|
|
|
|
|
'';
|
|
|
|
|
description = "Font configuration for window titles, nagbar...";
|
2021-05-04 05:54:35 +02:00
|
|
|
|
};
|
2019-09-04 04:30:44 +02:00
|
|
|
|
|
|
|
|
|
window = mkOption {
|
|
|
|
|
type = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
titlebar = mkOption {
|
|
|
|
|
type = types.bool;
|
2023-01-08 22:05:36 +01:00
|
|
|
|
default = if versionOlder stateVersion "23.05" then
|
|
|
|
|
(isI3 && (cfg.config.gaps == null))
|
2019-09-04 04:30:44 +02:00
|
|
|
|
else
|
2023-01-08 22:05:36 +01:00
|
|
|
|
true;
|
|
|
|
|
defaultText = if isI3 then ''
|
|
|
|
|
true for state version ≥ 23.05
|
|
|
|
|
config.gaps == null for state version < 23.05
|
|
|
|
|
'' else ''
|
|
|
|
|
true for state version ≥ 23.05
|
|
|
|
|
false for state version < 23.05
|
|
|
|
|
'';
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = "Whether to show window titlebars.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
border = mkOption {
|
|
|
|
|
type = types.int;
|
|
|
|
|
default = 2;
|
|
|
|
|
description = "Window border width.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
hideEdgeBorders = mkOption {
|
|
|
|
|
type = types.enum [ "none" "vertical" "horizontal" "both" "smart" ];
|
|
|
|
|
default = "none";
|
|
|
|
|
description = "Hide window borders adjacent to the screen edges.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
commands = mkOption {
|
|
|
|
|
type = types.listOf windowCommandModule;
|
|
|
|
|
default = [ ];
|
|
|
|
|
description = ''
|
|
|
|
|
List of commands that should be executed on specific windows.
|
|
|
|
|
See <option>for_window</option> ${moduleName}wm option documentation.
|
|
|
|
|
'';
|
|
|
|
|
example = [{
|
|
|
|
|
command = "border pixel 1";
|
|
|
|
|
criteria = { class = "XTerm"; };
|
|
|
|
|
}];
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
default = { };
|
|
|
|
|
description = "Window titlebar and border settings.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
floating = mkOption {
|
|
|
|
|
type = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
titlebar = mkOption {
|
|
|
|
|
type = types.bool;
|
2023-01-08 22:05:36 +01:00
|
|
|
|
default = if versionOlder stateVersion "23.05" then
|
|
|
|
|
(isI3 && (cfg.config.gaps == null))
|
2019-09-04 04:30:44 +02:00
|
|
|
|
else
|
2023-01-08 22:05:36 +01:00
|
|
|
|
true;
|
|
|
|
|
defaultText = if isI3 then ''
|
|
|
|
|
true for state version ≥ 23.05
|
|
|
|
|
config.gaps == null for state version < 23.05
|
|
|
|
|
'' else ''
|
|
|
|
|
true for state version ≥ 23.05
|
|
|
|
|
false for state version < 23.05
|
|
|
|
|
'';
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = "Whether to show floating window titlebars.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
border = mkOption {
|
|
|
|
|
type = types.int;
|
|
|
|
|
default = 2;
|
|
|
|
|
description = "Floating windows border width.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
modifier = mkOption {
|
|
|
|
|
type =
|
|
|
|
|
types.enum [ "Shift" "Control" "Mod1" "Mod2" "Mod3" "Mod4" "Mod5" ];
|
|
|
|
|
default = cfg.config.modifier;
|
2020-02-27 08:50:39 +01:00
|
|
|
|
defaultText = "${moduleName}.config.modifier";
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description =
|
|
|
|
|
"Modifier key that can be used to drag floating windows.";
|
|
|
|
|
example = "Mod4";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
criteria = mkOption {
|
|
|
|
|
type = types.listOf criteriaModule;
|
|
|
|
|
default = [ ];
|
|
|
|
|
description =
|
|
|
|
|
"List of criteria for windows that should be opened in a floating mode.";
|
|
|
|
|
example = [
|
|
|
|
|
{ "title" = "Steam - Update News"; }
|
|
|
|
|
{ "class" = "Pavucontrol"; }
|
|
|
|
|
];
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
default = { };
|
|
|
|
|
description = "Floating window settings.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
focus = mkOption {
|
|
|
|
|
type = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
newWindow = mkOption {
|
|
|
|
|
type = types.enum [ "smart" "urgent" "focus" "none" ];
|
|
|
|
|
default = "smart";
|
|
|
|
|
description = ''
|
|
|
|
|
This option modifies focus behavior on new window activation.
|
|
|
|
|
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#focus_on_window_activation"/>
|
|
|
|
|
'';
|
|
|
|
|
example = "none";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
followMouse = mkOption {
|
2021-01-11 18:18:32 +01:00
|
|
|
|
type = if isSway then
|
2020-05-11 23:56:40 +02:00
|
|
|
|
types.either (types.enum [ "yes" "no" "always" ]) types.bool
|
|
|
|
|
else
|
|
|
|
|
types.bool;
|
2021-01-11 18:18:32 +01:00
|
|
|
|
default = if isSway then "yes" else true;
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = "Whether focus should follow the mouse.";
|
2020-05-11 23:56:40 +02:00
|
|
|
|
apply = val:
|
2022-04-08 06:36:13 +02:00
|
|
|
|
if (isSway && isBool val) then (lib.hm.booleans.yesNo val) else val;
|
2019-09-04 04:30:44 +02:00
|
|
|
|
};
|
|
|
|
|
|
2023-01-15 19:20:13 +01:00
|
|
|
|
wrapping = mkOption {
|
|
|
|
|
type = types.enum [ "yes" "no" "force" "workspace" ];
|
|
|
|
|
default = {
|
|
|
|
|
i3 = if cfg.config.focus.forceWrapping then "force" else "yes";
|
|
|
|
|
# the sway module's logic was inverted and incorrect,
|
|
|
|
|
# so preserve it for backwards compatibility purposes
|
|
|
|
|
sway = if cfg.config.focus.forceWrapping then "yes" else "no";
|
|
|
|
|
}.${moduleName};
|
|
|
|
|
description = ''
|
|
|
|
|
Whether the window focus commands automatically wrap around the edge of containers.
|
|
|
|
|
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#_focus_wrapping"/>
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2019-09-04 04:30:44 +02:00
|
|
|
|
forceWrapping = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = false;
|
|
|
|
|
description = ''
|
2023-01-15 19:20:13 +01:00
|
|
|
|
Whether to force focus wrapping in tabbed or stacked containers.
|
2019-09-04 04:30:44 +02:00
|
|
|
|
|
2023-01-15 19:20:13 +01:00
|
|
|
|
This option is deprecated, use <option>focus.wrapping</option> instead.
|
2019-09-04 04:30:44 +02:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
mouseWarping = mkOption {
|
2022-08-25 21:02:04 +02:00
|
|
|
|
type = if isSway then
|
|
|
|
|
types.oneOf [ types.bool (types.enum [ "container" "output" ]) ]
|
|
|
|
|
else
|
|
|
|
|
types.bool;
|
2019-09-04 04:30:44 +02:00
|
|
|
|
default = true;
|
|
|
|
|
description = ''
|
|
|
|
|
Whether mouse cursor should be warped to the center of the window when switching focus
|
|
|
|
|
to a window on a different output.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
default = { };
|
|
|
|
|
description = "Focus related settings.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
assigns = mkOption {
|
|
|
|
|
type = types.attrsOf (types.listOf criteriaModule);
|
|
|
|
|
default = { };
|
|
|
|
|
description = ''
|
|
|
|
|
An attribute set that assigns applications to workspaces based
|
|
|
|
|
on criteria.
|
|
|
|
|
'';
|
2021-10-09 11:14:08 +02:00
|
|
|
|
example = literalExpression ''
|
2019-09-04 04:30:44 +02:00
|
|
|
|
{
|
|
|
|
|
"1: web" = [{ class = "^Firefox$"; }];
|
|
|
|
|
"0: extra" = [{ class = "^Firefox$"; window_role = "About"; }];
|
|
|
|
|
}
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
modifier = mkOption {
|
|
|
|
|
type = types.enum [ "Shift" "Control" "Mod1" "Mod2" "Mod3" "Mod4" "Mod5" ];
|
|
|
|
|
default = "Mod1";
|
|
|
|
|
description = "Modifier key that is used for all default keybindings.";
|
|
|
|
|
example = "Mod4";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
workspaceLayout = mkOption {
|
2021-08-18 04:58:03 +02:00
|
|
|
|
type = types.enum [ "default" "stacking" "tabbed" ];
|
2019-09-04 04:30:44 +02:00
|
|
|
|
default = "default";
|
|
|
|
|
example = "tabbed";
|
|
|
|
|
description = ''
|
|
|
|
|
The mode in which new containers on workspace level will
|
|
|
|
|
start.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
workspaceAutoBackAndForth = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = false;
|
|
|
|
|
example = true;
|
|
|
|
|
description = ''
|
|
|
|
|
Assume you are on workspace "1: www" and switch to "2: IM" using
|
|
|
|
|
mod+2 because somebody sent you a message. You don’t need to remember
|
|
|
|
|
where you came from now, you can just press $mod+2 again to switch
|
|
|
|
|
back to "1: www".
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
keycodebindings = mkOption {
|
|
|
|
|
type = types.attrsOf (types.nullOr types.str);
|
|
|
|
|
default = { };
|
|
|
|
|
description = ''
|
|
|
|
|
An attribute set that assigns keypress to an action using key code.
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#keybindings"/>.
|
|
|
|
|
'';
|
|
|
|
|
example = { "214" = "exec /bin/script.sh"; };
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
colors = mkOption {
|
|
|
|
|
type = types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
background = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
default = "#ffffff";
|
|
|
|
|
description = ''
|
|
|
|
|
Background color of the window. Only applications which do not cover
|
|
|
|
|
the whole area expose the color.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
focused = mkOption {
|
|
|
|
|
type = colorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#4c7899";
|
|
|
|
|
background = "#285577";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
indicator = "#2e9ef4";
|
|
|
|
|
childBorder = "#285577";
|
|
|
|
|
};
|
|
|
|
|
description = "A window which currently has the focus.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
focusedInactive = mkOption {
|
|
|
|
|
type = colorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#5f676a";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
indicator = "#484e50";
|
|
|
|
|
childBorder = "#5f676a";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
A window which is the focused one of its container,
|
|
|
|
|
but it does not have the focus at the moment.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
unfocused = mkOption {
|
|
|
|
|
type = colorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#222222";
|
|
|
|
|
text = "#888888";
|
|
|
|
|
indicator = "#292d2e";
|
|
|
|
|
childBorder = "#222222";
|
|
|
|
|
};
|
|
|
|
|
description = "A window which is not focused.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
urgent = mkOption {
|
|
|
|
|
type = colorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#2f343a";
|
|
|
|
|
background = "#900000";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
indicator = "#900000";
|
|
|
|
|
childBorder = "#900000";
|
|
|
|
|
};
|
|
|
|
|
description = "A window which has its urgency hint activated.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
placeholder = mkOption {
|
|
|
|
|
type = colorSetModule;
|
|
|
|
|
default = {
|
|
|
|
|
border = "#000000";
|
|
|
|
|
background = "#0c0c0c";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
indicator = "#000000";
|
|
|
|
|
childBorder = "#0c0c0c";
|
|
|
|
|
};
|
|
|
|
|
description = ''
|
|
|
|
|
Background and text color are used to draw placeholder window
|
|
|
|
|
contents (when restoring layouts). Border and indicator are ignored.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
default = { };
|
|
|
|
|
description = ''
|
|
|
|
|
Color settings. All color classes can be specified using submodules
|
|
|
|
|
with 'border', 'background', 'text', 'indicator' and 'childBorder' fields
|
|
|
|
|
and RGB color hex-codes as values. See default values for the reference.
|
|
|
|
|
Note that '${moduleName}.config.colors.background' parameter takes a single RGB value.
|
|
|
|
|
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#_changing_colors"/>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
bars = mkOption {
|
|
|
|
|
type = types.listOf barModule;
|
2023-01-08 22:05:36 +01:00
|
|
|
|
default = if versionAtLeast stateVersion "20.09" then [{
|
2020-07-13 13:31:55 +02:00
|
|
|
|
mode = "dock";
|
|
|
|
|
hiddenState = "hide";
|
|
|
|
|
position = "bottom";
|
|
|
|
|
workspaceButtons = true;
|
|
|
|
|
workspaceNumbers = true;
|
|
|
|
|
statusCommand = "${pkgs.i3status}/bin/i3status";
|
2021-05-04 05:54:35 +02:00
|
|
|
|
fonts = {
|
|
|
|
|
names = [ "monospace" ];
|
|
|
|
|
size = 8.0;
|
|
|
|
|
};
|
2020-07-13 13:31:55 +02:00
|
|
|
|
trayOutput = "primary";
|
|
|
|
|
colors = {
|
|
|
|
|
background = "#000000";
|
|
|
|
|
statusline = "#ffffff";
|
|
|
|
|
separator = "#666666";
|
|
|
|
|
focusedWorkspace = {
|
|
|
|
|
border = "#4c7899";
|
|
|
|
|
background = "#285577";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
activeWorkspace = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#5f676a";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
inactiveWorkspace = {
|
|
|
|
|
border = "#333333";
|
|
|
|
|
background = "#222222";
|
|
|
|
|
text = "#888888";
|
|
|
|
|
};
|
|
|
|
|
urgentWorkspace = {
|
|
|
|
|
border = "#2f343a";
|
|
|
|
|
background = "#900000";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
bindingMode = {
|
|
|
|
|
border = "#2f343a";
|
|
|
|
|
background = "#900000";
|
|
|
|
|
text = "#ffffff";
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
}] else
|
|
|
|
|
[ { } ];
|
2021-10-09 11:14:08 +02:00
|
|
|
|
defaultText = literalExpression "see code";
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = ''
|
|
|
|
|
${capitalModuleName} bars settings blocks. Set to empty list to remove bars completely.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
startup = mkOption {
|
|
|
|
|
type = types.listOf startupModule;
|
|
|
|
|
default = [ ];
|
|
|
|
|
description = ''
|
|
|
|
|
Commands that should be executed at startup.
|
|
|
|
|
|
|
|
|
|
See <link xlink:href="https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup"/>.
|
|
|
|
|
'';
|
2021-01-11 18:18:32 +01:00
|
|
|
|
example = if isI3 then
|
2021-10-09 11:14:08 +02:00
|
|
|
|
literalExpression ''
|
2020-09-24 11:16:54 +02:00
|
|
|
|
[
|
|
|
|
|
{ command = "systemctl --user restart polybar"; always = true; notification = false; }
|
|
|
|
|
{ command = "dropbox start"; notification = false; }
|
2023-07-05 12:23:31 +02:00
|
|
|
|
{ command = "firefox"; }
|
2020-09-24 11:16:54 +02:00
|
|
|
|
];
|
|
|
|
|
''
|
|
|
|
|
else
|
2021-10-09 11:14:08 +02:00
|
|
|
|
literalExpression ''
|
2020-09-24 11:16:54 +02:00
|
|
|
|
[
|
|
|
|
|
{ command = "systemctl --user restart waybar"; always = true; }
|
|
|
|
|
{ command = "dropbox start"; }
|
|
|
|
|
{ command = "firefox"; }
|
|
|
|
|
]
|
|
|
|
|
'';
|
2019-09-04 04:30:44 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
gaps = mkOption {
|
|
|
|
|
type = types.nullOr (types.submodule {
|
|
|
|
|
options = {
|
|
|
|
|
inner = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Inner gaps value.";
|
|
|
|
|
example = 12;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
outer = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Outer gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
horizontal = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Horizontal gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
vertical = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Vertical gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
top = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Top gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
left = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Left gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
bottom = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Bottom gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
right = mkOption {
|
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
|
default = null;
|
|
|
|
|
description = "Right gaps value.";
|
|
|
|
|
example = 5;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
smartGaps = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = false;
|
|
|
|
|
description = ''
|
|
|
|
|
This option controls whether to disable all gaps (outer and inner)
|
|
|
|
|
on workspace with a single container.
|
|
|
|
|
'';
|
|
|
|
|
example = true;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
smartBorders = mkOption {
|
|
|
|
|
type = types.enum [ "on" "off" "no_gaps" ];
|
|
|
|
|
default = "off";
|
|
|
|
|
description = ''
|
|
|
|
|
This option controls whether to disable container borders on
|
|
|
|
|
workspace with a single container.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
});
|
|
|
|
|
default = null;
|
2023-01-08 22:05:36 +01:00
|
|
|
|
description = ''
|
2019-09-04 04:30:44 +02:00
|
|
|
|
Gaps related settings.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
terminal = mkOption {
|
|
|
|
|
type = types.str;
|
2023-01-03 19:26:08 +01:00
|
|
|
|
default = if isI3 then "i3-sensible-terminal" else "${pkgs.foot}/bin/foot";
|
2019-09-04 04:30:44 +02:00
|
|
|
|
description = "Default terminal to run.";
|
|
|
|
|
example = "alacritty";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
menu = mkOption {
|
|
|
|
|
type = types.str;
|
2021-01-11 18:18:32 +01:00
|
|
|
|
default = if isSway then
|
2019-09-04 04:30:44 +02:00
|
|
|
|
"${pkgs.dmenu}/bin/dmenu_path | ${pkgs.dmenu}/bin/dmenu | ${pkgs.findutils}/bin/xargs swaymsg exec --"
|
|
|
|
|
else
|
|
|
|
|
"${pkgs.dmenu}/bin/dmenu_run";
|
|
|
|
|
description = "Default launcher to use.";
|
|
|
|
|
example = "bemenu-run";
|
|
|
|
|
};
|
2021-05-17 06:54:53 +02:00
|
|
|
|
|
|
|
|
|
defaultWorkspace = mkOption {
|
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
|
default = null;
|
|
|
|
|
description = ''
|
|
|
|
|
The default workspace to show when ${
|
|
|
|
|
if isSway then "sway" else "i3"
|
|
|
|
|
} is launched.
|
|
|
|
|
This must to correspond to the value of the keybinding of the default workspace.
|
|
|
|
|
'';
|
|
|
|
|
example = "workspace number 9";
|
|
|
|
|
};
|
2021-06-03 02:03:20 +02:00
|
|
|
|
|
|
|
|
|
workspaceOutputAssign = mkOption {
|
|
|
|
|
type = with types;
|
|
|
|
|
let
|
|
|
|
|
workspaceOutputOpts = submodule {
|
|
|
|
|
options = {
|
|
|
|
|
workspace = mkOption {
|
|
|
|
|
type = str;
|
|
|
|
|
default = "";
|
|
|
|
|
example = "Web";
|
|
|
|
|
description = ''
|
|
|
|
|
Name of the workspace to assign.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
output = mkOption {
|
|
|
|
|
type = str;
|
|
|
|
|
default = "";
|
|
|
|
|
example = "eDP";
|
|
|
|
|
description = ''
|
|
|
|
|
Name of the output from <command>
|
|
|
|
|
${if isSway then "swaymsg" else "i3-msg"} -t get_outputs
|
|
|
|
|
</command>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
in listOf workspaceOutputOpts;
|
|
|
|
|
default = [ ];
|
|
|
|
|
description = "Assign workspaces to outputs.";
|
|
|
|
|
};
|
2019-09-04 04:30:44 +02:00
|
|
|
|
}
|