docs: recommend LSUIElement for packaged apps hiding the dock icon - #135
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents that
showDockIcon: falsealone is best-effort on macOS: the runtimeapp.dock.hide()is a process transform that runs after the app has already launched as a regular dock app, and macOS can silently drop it when it races the launch activation (#123 added a one-shot re-assert for exactly that). gitify-app/gitify#3069 showed the transform can still be lost on a real machine, and the durable fix there was declaringLSUIElementin the packagedInfo.plist(gitify-app/gitify#3117), so the process starts as an agent app and no dock tile ever exists.This adds that recommendation where consumers will find it:
README.md: expands theshowDockIconrow with a collapsible note explaining the startup re-assert, why hiding at runtime stays best-effort, and theLSUIElement/mac.extendInforecipe for electron-builder.src/types.ts: the same guidance on theshowDockIconJSDoc, so it surfaces in editor hover.Docs only, no runtime change.
lint:checkandtypecheckpass.