DockProgress
Show progress in your app's Dock icon
This package is used in production by the Gifski app. You might also like some of my other apps.
Requirements
- macOS 10.12+
- Xcode 12+
- Swift 5.3+
Install
Swift Package Manager
Add https://github.com/sindresorhus/DockProgress
in the “Swift Package Manager” tab in Xcode.
Carthage
github "sindresorhus/DockProgress"
CocoaPods
pod 'DockProgress'
Usage
Manually set the progress
import Cocoa
import DockProgress
foo.onUpdate = { progress in
DockProgress.progress = progress
}
Progress
instance
Specify a import Cocoa
import DockProgress
let progress = Progress(totalUnitCount: 1)
progress?.becomeCurrent(withPendingUnitCount: 1)
DockProgress.progressInstance = progress
The given Progress
instance is weakly stored. It's up to you to retain it.
Styles
It comes with three styles. PR welcome for more.
Check out the example app in the Xcode project.
You can also draw a custom progress with .custom(drawHandler: (_ rect: CGRect) -> Void)
.
Bar
import DockProgress
DockProgress.style = .bar
This is the default.
Squircle
import DockProgress
DockProgress.style = .squircle(color: NSColor.white.withAlphaComponent(0.5))
By default, it should perfectly fit a macOS 11 icon, but there's a inset
parameter if you need to make any adjustments.
Circle
import DockProgress
DockProgress.style = .circle(radius: 55, color: .systemBlue)
Make sure to set a radius
that matches your app icon.
Badge
import DockProgress
DockProgress.style = .badge(color: .systemBlue, badgeValue: { getDownloadCount() })
Large badgeValue
numbers will be written in kilo short notation, for example, 1012
→ 1k
.
Note: The badgeValue
is not meant to be used as a numeric percentage. It's for things like count of downloads, number of files being converted, etc.
Related
- Defaults - Swifty and modern UserDefaults
- Preferences - Add a preferences window to your macOS app in minutes
- KeyboardShortcuts - Add user-customizable global keyboard shortcuts to your macOS app
- LaunchAtLogin - Add "Launch at Login" functionality to your macOS app
- More…