Hiding a macOS app from the Dock: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | ## Overview | |
| 2 | 2 | ||
| 3 | 3 | While there is no way to hide an application from the Dock at runtime, this can be done at design-time if the application declares itself to be an agent or a background application. These two application categories and their attributes are explained below. | |
| 4 | 4 | ||
| 5 | 5 | ## Agent applications | |
| 6 | 6 | ||
| 7 | 7 | Agent applications do not appear in the Dock or in the Force Quit window; but they *are visible* to utilities like Activity Monitor, Unix command-line tools (eg top), as well as macOS API functions.. If the agent key exists and is set to YES in the application's .plist file, Launch Services runs the application as an agent. Although they typically run as background applications, they can come to the foreground to present a user interface if desired. A click on a window belonging to an agent application brings that application forward to handle events. | |
| 8 | 8 | ||
| 9 | 9 | Agents are often shown in the macOS menu bar, in which case the agent application should provide a StatusBar (TTrayIcon) user interface and hotkeys if it needs a menu-like user interface. | |
| 10 | 10 | ||
| 11 | 11 | For example, startlazarus is an agent application, launched by the Lazarus IDE when rebuilt. Similarly, the Dock and Login Window are also two applications that run as agents. | |
| 12 | 12 | ||
| 13 | 13 | To declare an application to be an **agent application**, use Xcode to open the application's bundle Info.plist file: | |
| 14 | 14 | ||
| 15 | 15 | - add a property *UIElement* (or "Application is agent"); | |
| 16 | 16 | - set the *UIElement* property's value to True; | |
| 17 | 17 | - save the Info.plist file. | |
| 18 | 18 | ||
| 19 | - | ||
| 20 | - | ||
| 21 | - | ||
| 22 | - | ||
| 19 | + |  | |
| 23 | 20 | ||
| 24 | 21 | ## Background only applications | |
| 25 | 22 | ||
| 26 | 23 | A background only application runs only in the background. If background application key exists and is set to YES, Launch Services runs the application in the background only. You can use this key to create faceless background applications. You should also use this key if your application uses higher-level frameworks that connect to the window server, but are not intended to be visible to users. | |
| 27 | 24 | ||
| 28 | 25 | As background applications are *never shown* in the macOS menu bar, you should be launch/terminate the application with another GUI application. | |
| 29 | 26 | ||
| 30 | 27 | To declare an application to be a **background application**, use Xcode to open the application's bundle Info.plist file: | |
| 31 | 28 | ||
| 32 | 29 | - add a property *LSBackgroundOnly* (or "Application is background only"); | |
| 33 | 30 | - set the *LSBackgroundOnly* property's value to True; | |
| 34 | 31 | - save the Info.plist file. | |
| 35 | 32 | ||
| 36 | - | ||
| 37 | - | ||
| 38 | - | ||
| 39 | - | ||
| 33 | + |  | |
| 40 | 34 | ||
| 41 | 35 | ## See also | |
| 42 | 36 | ||
| 43 | 37 | - [[Application disable resize over Dock]] | |
| 44 | 38 | - [[Bounce Application Icon in Dock]] | |
| 45 | 39 | - [[macOS Application Dock Menu]] | |
| 46 | 40 | - [[Show Badge on Application Icon in Dock]] | |
| 47 | 41 | ||
| 48 | 42 | ## External links | |
| 49 | 43 | ||
| 50 | 44 | - [Apple: Technical Note TN2083 - Daemons and Agents](https://developer.apple.com/library/archive/technotes/tn2083/_index.html#/apple_ref/doc/uid/DTS10003794) | |
| 51 | 45 | - [Apple: Pre Login Agents](https://developer.apple.com/library/archive/samplecode/PreLoginAgents/Introduction/Intro.html#//apple_ref/doc/uid/DTS10004414) | |
| 52 | 46 | - [Apple: Daemons and Services Programming Guide](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/Introduction.html#//apple_ref/doc/uid/10000172i-SW1-SW1) | |
| 53 | 47 | ||
| 54 | 48 | --- | |
| 55 | 49 | *From the Free Pascal wiki, page "Hiding a macOS app from the Dock", as it stood on 2021-12-15 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 56 | 50 | Category: Platform-sensitive development | |
| 57 | 51 | Category: macOS |