PayloadKit

Dock

com.apple.dock

The payload that configures the Dock.

macOS 10.7+
Apple schemacombined

Not available with User Enrollment · Only one instance per profile

Configuration Keys (44)

Showing 44 of 44 keys

KeyTypeDescriptionDefaultRange

Static Apps

arrayAn array of items located on the Applications side of the Dock that users can't remove from that location.Default: —Range: —
dictItems that are located on the Documents side of the Dock and cannot be removed from that location.Default: —Range: —
tile-typestring

Type

required
stringThe type of tile.Default: "file-tile"Range: File (file-tile)

Information

required
dictThe information about the Dock item.Default: —Range: —
labelstring

Label

required
stringThe label of the Dock item.Default: —Range: —

Display Name

stringDisplay name in the profile GUI of a dock item.Default: —Range: —
file-typeinteger

Type

required
integerThe type of tile.Default: —Range: File (1)

File Data

required
dictThe data in a file. For Apple use only.Default: —Range: —

Path

stringPath to the application.Default: —Range: —

Path Type

integerPath type. 0 = /Path/to/item, 15 = file://Path/to/itemDefault: —Range: Path (0), File URL (15)
urlstring
stringThe URL string.Default: —Range: —

Static Others

arrayAn array of items located on the Documents side of the Dock that users can't remove from that location.Default: —Range: —

Static Other

dictItems that are located on the Documents side of the Dock and cannot be removed from that location.Default: —Range: —
tile-typestring

Type

required
stringThe type of tile.Default: "file-tile"Range: File (file-tile), Directory (directory-tile), URL (url-tile)

Information

required
dictThe information about the Dock item.Default: —Range: —
labelstring

Label

required
stringThe label of the Dock item.Default: —Range: —

Display Name

stringDisplay name in the profile GUI of a dock item.Default: —Range: —
urlstring

URL

stringThe URL string.Default: —Range: —
file-typeinteger

Type

required
integerThe type of tile: '0': URL '1': File '3': DirectoryDefault: —Range: URL (0), File (1), Directory (3)

File Data

required
dictThe data in a file. For Apple use only.Default: —Range: —

Path

stringPath to the file.Default: —Range: —

Path Type

integerPath type. 0 = /Path/to/item, 15 = file://Path/to/itemDefault: —Range: Path (0), File URL (15)

Home Directory Relative

stringPath to item relative to the current user's home directory.Default: —Range: —

Arrangement

integerArrangement (sorting) of the directory contents.Default: 1Range: Name (1), Date Added (2), Date Modified (3), Date Created (4), Kind (5)
displayasinteger

Display As

integerDisplay directory as either a Folder or a Stack.Default: 2Range: Folder (1), Stack (2)
showasinteger

Show As

integerHow to show directory contents.Default: 4Range: Fan (1), Grid (2), List (3), Automatic (4)

Persistent Apps

arrayAn array of items located on the Applications side of the Dock that users can remove from the Dock.Default: —Range: —
dictItems that are located on the Documents side of the Dock and cannot be removed from that location.Default: —Range: —
tile-typestring

Type

required
stringThe type of tile.Default: "file-tile"Range: File (file-tile)

Information

required
dictThe information about the Dock item.Default: —Range: —
labelstring

Label

required
stringThe label of the Dock item.Default: —Range: —

Display Name

stringDisplay name in the profile GUI of a dock item.Default: —Range: —
file-typeinteger

Type

required
integerThe type of tile.Default: —Range: File (1)

File Data

required
dictThe data in a file. For Apple use only.Default: —Range: —

Path

stringPath to the application.Default: —Range: —

Path Type

integerPath type. 0 = /Path/to/item, 15 = file://Path/to/itemDefault: —Range: Path (0), File URL (15)
urlstring
stringThe URL string.Default: —Range: —

Persistent Others

arrayAn array of items located on the Documents side of the Dock that users can remove from the Dock.Default: —Range: —

Static Other

dictItems that are located on the Documents side of the Dock and cannot be removed from that location.Default: —Range: —
tile-typestring

Type

required
stringThe type of tile.Default: "file-tile"Range: File (file-tile), Directory (directory-tile), URL (url-tile)

Information

required
dictThe information about the Dock item.Default: —Range: —
labelstring

Label

required
stringThe label of the Dock item.Default: —Range: —

Display Name

stringDisplay name in the profile GUI of a dock item.Default: —Range: —
urlstring

URL

stringThe URL string.Default: —Range: —
file-typeinteger

Type

required
integerThe type of tile: '0': URL '1': File '3': DirectoryDefault: —Range: URL (0), File (1), Directory (3)

File Data

required
dictThe data in a file. For Apple use only.Default: —Range: —

Path

stringPath to the file.Default: —Range: —

Path Type

integerPath type. 0 = /Path/to/item, 15 = file://Path/to/itemDefault: —Range: Path (0), File URL (15)

Home Directory Relative

stringPath to item relative to the current user's home directory.Default: —Range: —

Arrangement

integerArrangement (sorting) of the directory contents.Default: 1Range: Name (1), Date Added (2), Date Modified (3), Date Created (4), Kind (5)
displayasinteger

Display As

integerDisplay directory as either a Folder or a Stack.Default: 2Range: Folder (1), Stack (2)
showasinteger

Show As

integerHow to show directory contents.Default: 4Range: Fan (1), Grid (2), List (3), Automatic (4)
tilesizeinteger

Size

integerThe tile size. Values must be in the range from 16 to 128.Default: 64Range: 16 – 128

Size slider disabled

booleanIf 'true', locks the size slider.Default: falseRange: —

Enable magnification

booleanIf 'true', enables magnification.Default: falseRange: —

Enable magnification checkbox disabled

booleanIf 'true', locks magnification.Default: falseRange: —
largesizeinteger

Magnification

integerThe size of the largest magnification.Default: 128Range: 16 – 128

Magnification slider disabled

booleanIf 'true', locks the magnification slider.Default: falseRange: —

Position on screen

stringThe orientation of the Dock.Default: —Range: Bottom (bottom), Left (left), Right (right)

Position on screen buttons disabled

booleanIf 'true', locks the position.Default: falseRange: —
mineffectstring

Minimize window effect

stringThe minimize effect.Default: "genie"Range: Genie Effect (genie), Scale Effect (scale)

Minimize window effect button disabled

booleanIf 'true', locks "Minimize windows using."Default: falseRange: —

Minimize windows into application icon

booleanIf 'true', enables "Minimize windows into application icon."Default: falseRange: —

Minimize windows into application icon Checkbox Disable

macOS 10.14+

booleanIf 'true', disables the "Minimize windows into application icon" checkbox.Default: falseRange: —
launchanimboolean

Animate opening applications

booleanIf 'true', enables "Animate opening applications."Default: falseRange: —

Animate opening applications checkbox disabled

booleanIf 'true', locks "Animate opening applications."Default: falseRange: —
autohideboolean

Automatically hide and show the Dock

booleanIf 'true', enables "Automatically hide and show the Dock."Default: falseRange: —

Automatically hide and show the Dock checkbox disabled

booleanIf 'true', locks "Automatically hide."Default: falseRange: —

Show delay

realDelay in seconds before a hidden Dock is shown.Default: 0.2Range: —

Show and hide animation duration

realDuration in seconds of Dock show and hide sliding animations.Default: 0.5Range: —

Show indicators for open applications

booleanIf true, shows the process indicator.Default: falseRange: —

Show recent applications in Dock

macOS 10.14+

booleanIf 'true', enables "Show recent items."Default: falseRange: —

Number of recent applications

integerControls the number of items shown in the recent apps area of the dock.Default: 3Range: —

Remove non-static apps and documents from Dock

booleanIf 'true', uses the 'static-apps' and 'static-others' dictionaries for the Dock and ignores any items in the 'persistent-apps' and 'persistent-others' dictionaries. If 'false', the contents are merged with the static items listed first.Default: falseRange: —

Prevent modifying items in Dock

booleanIf 'true', disables changes to the Dock.Default: falseRange: —

Allow DockFixup override

macOS 10.12+

booleanIf 'true', use the file in '/Library/Preferences/com.apple.dockfixup.plist' when a new user or migrated user logs in. This option has no effect for existing users. Only available on the device channel.Default: falseRange: —

Managed Client Special Folders

arrayOne or more special folders that the device may create at user login time and place in the Dock. The "My Applications" item is only used for Simple Finder environments. The "Original Network Home" item is only used for mobile account users.Default: —Range: —
stringFlag for the folder to be added by Managed Client.Default: —Range: My apps (AddDockMCXMyApplicationsFolder), Documents (AddDockMCXDocumentsFolder), Shared Items (AddDockMCXSharedFolder), Network home (AddDockMCXOriginalNetworkHomeFolder)

Top Left Hot Corner Action

integerAction to be taken when the pointer enters the top left corner of the screenDefault: 0Range: Start Screen Saver (5), Disable Screen Saver (6), Mission Control (2), Application Windows (3), Desktop (4), Dashboard (removed from macOS 10.15) (7), Notification Center (12), Launchpad (11), Quick Note (introduced on macOS 12.0) (14), Put Display to Sleep (10), Lock Screen (13), No Action (0)

Top Left Hot Corner Modifier

integerModifier keys required to activate the top left hot cornerDefault: 0Range: None (0), Command (1048576), Command+Option (1572864), Command+Option+Control (1835008), Command+Option+Control+Shift (1966080), Command+Option+Shift (1703936), Command+Control (1310720), Command+Control+Shift (1441792), Command+Shift (1179648), Option (524288), Option+Control (786432), Option+Control+Shift (917504), Option+Shift (655360), Control (262144), Control+Shift (393216), Shift (131072)

Top Right Hot Corner Action

integerAction to be taken when the pointer enters the top right corner of the screenDefault: 0Range: Start Screen Saver (5), Disable Screen Saver (6), Mission Control (2), Application Windows (3), Desktop (4), Dashboard (removed from macOS 10.15) (7), Notification Center (12), Launchpad (11), Quick Note (introduced on macOS 12.0) (14), Put Display to Sleep (10), Lock Screen (13), No Action (0)

Top Right Hot Corner Modifier

integerModifier keys required to activate the top right hot cornerDefault: 0Range: None (0), Command (1048576), Command+Option (1572864), Command+Option+Control (1835008), Command+Option+Control+Shift (1966080), Command+Option+Shift (1703936), Command+Control (1310720), Command+Control+Shift (1441792), Command+Shift (1179648), Option (524288), Option+Control (786432), Option+Control+Shift (917504), Option+Shift (655360), Control (262144), Control+Shift (393216), Shift (131072)

Bottom Left Hot Corner Action

integerAction to be taken when the pointer enters the bottom left corner of the screenDefault: 0Range: Start Screen Saver (5), Disable Screen Saver (6), Mission Control (2), Application Windows (3), Desktop (4), Dashboard (removed from macOS 10.15) (7), Notification Center (12), Launchpad (11), Quick Note (introduced on macOS 12.0) (14), Put Display to Sleep (10), Lock Screen (13), No Action (0)

Bottom Left Hot Corner Modifier

integerModifier keys required to activate the bottom left hot cornerDefault: 0Range: None (0), Command (1048576), Command+Option (1572864), Command+Option+Control (1835008), Command+Option+Control+Shift (1966080), Command+Option+Shift (1703936), Command+Control (1310720), Command+Control+Shift (1441792), Command+Shift (1179648), Option (524288), Option+Control (786432), Option+Control+Shift (917504), Option+Shift (655360), Control (262144), Control+Shift (393216), Shift (131072)

Bottom Right Hot Corner Action

integerAction to be taken when the pointer enters the bottom right corner of the screenDefault: 0Range: Start Screen Saver (5), Disable Screen Saver (6), Mission Control (2), Application Windows (3), Desktop (4), Dashboard (removed from macOS 10.15) (7), Notification Center (12), Launchpad (11), Quick Note (introduced on macOS 12.0) (14), Put Display to Sleep (10), Lock Screen (13), No Action (0)

Bottom Right Hot Corner Modifier

integerModifier keys required to activate the bottom right hot cornerDefault: 0Range: None (0), Command (1048576), Command+Option (1572864), Command+Option+Control (1835008), Command+Option+Control+Shift (1966080), Command+Option+Shift (1703936), Command+Control (1310720), Command+Control+Shift (1441792), Command+Shift (1179648), Option (524288), Option+Control (786432), Option+Control+Shift (917504), Option+Shift (655360), Control (262144), Control+Shift (393216), Shift (131072)

Prefer tabs when opening documents

macOS 10.15+

stringSet the "Prefer tabs when opening documents" to the provided value.Default: —Range: Manual (manual), Always (always), Fullscreen (fullscreen)

Prevent changing tabs preference

macOS 10.12+

booleanIf 'true', disables "Prefer tabs when opening documents" checkbox.Default: falseRange: —

Doubleclick behavior

macOS 10.15+

stringThe behavior when the window's title bar is double-clicked.Default: —Range: Minimize (minimize), Maximize (maximize), None (none)

Prevent changing doubleclick behavior

macOS 10.14+

booleanIf 'true', locks "Double-click a window's title bar."Default: falseRange: —

Prevent changing indicators display

booleanIf 'true', locks "Show indicators."Default: falseRange: —

Prevent shanging recents display

macOS 10.15+

booleanIf 'true', disables "Show recent applications" checkbox.Default: falseRange: —

Payload Enabled

booleanWhether this Dock configuration payload is enabled and should be applied to the system.Default: trueRange: —