8.nix-darwin/modules/system/defaults/dock.nix
Sam c3c8c9f2a5
Some checks failed
Test / test-stable (push) Has been cancelled
Test / install-against-stable (push) Has been cancelled
Test / install-flake (push) Has been cancelled
Update website / Build (push) Has been cancelled
Update website / Deploy (push) Has been cancelled
feat(trackpad): add additional trackpad and gesture support (#1591)
2025-11-01 23:27:41 +00:00

479 lines
16 KiB
Nix

{ config, lib, ... }:
with lib;
let
# Should only be used with options that previously used floats defined as strings.
inherit (config.lib.defaults.types) floatWithDeprecationError;
in {
imports = [
(mkRenamedOptionModule [ "system" "defaults" "dock" "expose-group-by-app" ] [ "system" "defaults" "dock" "expose-group-apps" ])
];
options = {
system.defaults.dock.appswitcher-all-displays = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to display the appswitcher on all displays or only the main one. The default is false.
'';
};
system.defaults.dock.autohide = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to automatically hide and show the dock. The default is false.
'';
};
system.defaults.dock.autohide-delay = mkOption {
type = types.nullOr floatWithDeprecationError;
default = null;
example = 0.24;
description = ''
Sets the speed of the autohide delay. The default is given in the example.
'';
};
system.defaults.dock.autohide-time-modifier = mkOption {
type = types.nullOr floatWithDeprecationError;
default = null;
example = 1.0;
description = ''
Sets the speed of the animation when hiding/showing the Dock. The default is given in the example.
'';
};
system.defaults.dock.dashboard-in-overlay = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to hide Dashboard as a Space. The default is false.
'';
};
system.defaults.dock.enable-spring-load-actions-on-all-items = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Enable spring loading for all Dock items. The default is false.
'';
};
system.defaults.dock.expose-animation-duration = mkOption {
type = types.nullOr floatWithDeprecationError;
default = null;
example = 1.0;
description = ''
Sets the speed of the Mission Control animations. The default is given in the example.
'';
};
system.defaults.dock.expose-group-apps = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to group windows by application in Mission Control's Exposé. The default is false.
'';
};
system.defaults.dock.launchanim = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Animate opening applications from the Dock. The default is true.
'';
};
system.defaults.dock.mineffect = mkOption {
type = types.nullOr (types.enum [ "genie" "suck" "scale" ]);
default = null;
description = ''
Set the minimize/maximize window effect. The default is genie.
'';
};
system.defaults.dock.minimize-to-application = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to minimize windows into their application icon. The default is false.
'';
};
system.defaults.dock.mouse-over-hilite-stack = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Enable highlight hover effect for the grid view of a stack in the Dock.
'';
};
system.defaults.dock.mru-spaces = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to automatically rearrange spaces based on most recent use. The default is true.
'';
};
system.defaults.dock.orientation = mkOption {
type = types.nullOr (types.enum [ "bottom" "left" "right" ]);
default = null;
description = ''
Position of the dock on screen. The default is "bottom".
'';
};
system.defaults.dock.persistent-apps = mkOption {
type = let
taggedType = types.attrTag {
app = mkOption {
description = "An application to be added to the dock.";
type = types.str;
};
file = mkOption {
description = "A file to be added to the dock.";
type = types.str;
};
folder = mkOption {
description = "A folder to be added to the dock.";
type = types.str;
};
spacer = mkOption {
description = "A spacer to be added to the dock. Can be small or regular size.";
type = types.submodule {
options.small = mkOption {
description = "Whether the spacer is small.";
type = types.bool;
default = false;
};
};
};
};
simpleType = types.either types.str types.path;
toTagged = path: { app = path; };
in
types.nullOr (types.listOf (types.coercedTo simpleType toTagged taggedType));
default = null;
example = [
{ app = "/Applications/Safari.app"; }
{ spacer = { small = false; }; }
{ spacer = { small = true; }; }
{ folder = "/System/Applications/Utilities"; }
{ file = "/User/example/Downloads/test.csv"; }
];
description = ''
Persistent applications, spacers, files, and folders in the dock.
'';
apply =
let
toTile = item: if item ? app then {
tile-data.file-data = {
_CFURLString = item.app;
_CFURLStringType = 0;
};
} else if item ? spacer then {
tile-data = { };
tile-type = if item.spacer.small then "small-spacer-tile" else "spacer-tile";
} else if item ? folder then {
tile-data.file-data = {
_CFURLString = "file://" + item.folder;
_CFURLStringType = 15;
};
tile-type = "directory-tile";
} else if item ? file then {
tile-data.file-data = {
_CFURLString = "file://" + item.file;
_CFURLStringType = 15;
};
tile-type = "file-tile";
} else item;
in
value: if value == null then null else map toTile value;
};
system.defaults.dock.persistent-others = mkOption {
type = let
folderType = types.submodule {
options.path = mkOption {
description = "Path to a folder to be added to the dock.";
type = types.str;
};
options.arrangement = mkOption {
description = "Sort order for files in folder when clicked.";
type = types.enum ["name" "date-added" "date-modified" "date-created" "kind"];
default = "name";
};
options.displayas = mkOption {
description = "How to display the folder before clicked. stack: Stack of file previews. folder: A folder icon";
type = types.enum ["stack" "folder"];
default = "stack";
};
options.showas = mkOption {
description = "Effect to show files when clicked. fan: fan-out effect, grid: box, list: list";
type = types.enum ["automatic" "fan" "grid" "list"];
default = "automatic";
};
};
taggedType = types.attrTag {
file = mkOption {
description = "A file to be added to the dock.";
type = types.str;
};
folder = mkOption {
description = "A folder to be added to the dock.";
type = types.coercedTo types.str (str: { path = str; }) folderType;
};
};
simpleType = types.either types.str types.path;
# Below to NOT break exisiting config
toTagged = _path: let path = builtins.toString _path; in if strings.hasInfix "." (last (splitString "/" path)) then { file = path; } else { folder = path; };
# toTagged = path: { folder = path; }; # or this to be consistent with persistent-apps
in
types.nullOr (types.listOf (types.coercedTo simpleType toTagged taggedType));
default = null;
example = lib.literalExpression ''
[
./flake.nix
"/Volumes"
{ folder = "/Users/@username@/Downloads"; }
{ folder = { path = "/Users/@username@/.emacs.d"; showas = "grid"; }; }
{ file = "/Users/@username@/Desktop/this_is_a_file"; }
]'';
description = ''
Persistent files, and folders in the dock.
'';
apply = let
arrangementMap = {
name = 1;
date-added = 2;
date-modified = 3;
date-created = 4;
kind = 5;
};
displayasMap = {
stack = 0;
folder = 1;
};
showasMap = {
automatic = 0;
fan = 1;
grid = 2;
list = 3;
};
parseFolder = (folder:
builtins.mapAttrs (name: val:
if name == "arrangement" then arrangementMap.${val}
else if name == "displayas" then displayasMap.${val}
else if name == "showas" then showasMap.${val}
else val
) folder
);
toTile = item: {
tile-data = {
file-data = {
_CFURLString = "file://" + (if item ? folder then item.folder.path else item.file);
_CFURLStringType = 15;
};
} // (if item ? folder then {inherit (parseFolder item.folder) arrangement displayas showas;} else {});
tile-type = if item ? folder then "directory-tile" else "file-tile";
};
in
value: if value == null then null else map toTile value;
};
system.defaults.dock.scroll-to-open = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Scroll up on a Dock icon to show all Space's opened windows for an app, or open stack. The default is false.
'';
};
system.defaults.dock.showAppExposeGestureEnabled = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to enable trackpad gestures (three- or four-finger vertical swipe) to show App Exposé. The default is false. This feature interacts with `system.defaults.trackpad.TrackpadFourFingerVertSwipeGesture` and `system.defaults.trackpad.TrackpadThreeFingerVertSwipeGesture` to determine which gesture triggers App Exposé.
'';
};
system.defaults.dock.showDesktopGestureEnabled = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to enable four-finger spread gesture to show the Desktop. The default is false.
'';
};
system.defaults.dock.showLaunchpadGestureEnabled = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to enable four-finger pinch gesture to show the Launchpad. The default is false.
'';
};
system.defaults.dock.showMissionControlGestureEnabled = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to enable trackpad gestures (three- or four-finger vertical swipe) to show Mission Control. The default is false. This feature interacts with `system.defaults.trackpad.TrackpadFourFingerVertSwipeGesture` and `system.defaults.trackpad.TrackpadThreeFingerVertSwipeGesture` to determine which gesture triggers Mission Control.
'';
};
system.defaults.dock.show-process-indicators = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Show indicator lights for open applications in the Dock. The default is true.
'';
};
system.defaults.dock.showhidden = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Whether to make icons of hidden applications tranclucent. The default is false.
'';
};
system.defaults.dock.show-recents = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Show recent applications in the dock. The default is true.
'';
};
system.defaults.dock.slow-motion-allowed = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Allow for slow-motion minimize effect while holding Shift key. The default is false.
'';
};
system.defaults.dock.static-only = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Show only open applications in the Dock. The default is false.
'';
};
system.defaults.dock.tilesize = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
Size of the icons in the dock. The default is 64.
'';
};
system.defaults.dock.magnification = mkOption {
type = types.nullOr types.bool;
default = null;
description = ''
Magnify icon on hover. The default is false.
'';
};
system.defaults.dock.largesize = mkOption {
type = types.nullOr (types.ints.between 16 128);
default = null;
description = ''
Magnified icon size on hover. The default is 16.
'';
};
system.defaults.dock.wvous-tl-corner = mkOption {
type = types.nullOr types.ints.positive;
default = null;
description = ''
Hot corner action for top left corner. Valid values include:
* `1`: Disabled
* `2`: Mission Control
* `3`: Application Windows
* `4`: Desktop
* `5`: Start Screen Saver
* `6`: Disable Screen Saver
* `7`: Dashboard
* `10`: Put Display to Sleep
* `11`: Launchpad
* `12`: Notification Center
* `13`: Lock Screen
* `14`: Quick Note
'';
};
system.defaults.dock.wvous-bl-corner = mkOption {
type = types.nullOr types.ints.positive;
default = null;
description = ''
Hot corner action for bottom left corner. Valid values include:
* `1`: Disabled
* `2`: Mission Control
* `3`: Application Windows
* `4`: Desktop
* `5`: Start Screen Saver
* `6`: Disable Screen Saver
* `7`: Dashboard
* `10`: Put Display to Sleep
* `11`: Launchpad
* `12`: Notification Center
* `13`: Lock Screen
* `14`: Quick Note
'';
};
system.defaults.dock.wvous-tr-corner = mkOption {
type = types.nullOr types.ints.positive;
default = null;
description = ''
Hot corner action for top right corner. Valid values include:
* `1`: Disabled
* `2`: Mission Control
* `3`: Application Windows
* `4`: Desktop
* `5`: Start Screen Saver
* `6`: Disable Screen Saver
* `7`: Dashboard
* `10`: Put Display to Sleep
* `11`: Launchpad
* `12`: Notification Center
* `13`: Lock Screen
* `14`: Quick Note
'';
};
system.defaults.dock.wvous-br-corner = mkOption {
type = types.nullOr types.ints.positive;
default = null;
description = ''
Hot corner action for bottom right corner. Valid values include:
* `1`: Disabled
* `2`: Mission Control
* `3`: Application Windows
* `4`: Desktop
* `5`: Start Screen Saver
* `6`: Disable Screen Saver
* `7`: Dashboard
* `10`: Put Display to Sleep
* `11`: Launchpad
* `12`: Notification Center
* `13`: Lock Screen
* `14`: Quick Note
'';
};
};
}