Skip to content

Happy-Ferret/DockProgress

 
 

Repository files navigation

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 9+
  • Swift 4+

Install

With SPM:

.package(url: "https://github.com/sindresorhus/DockProgress", from: "1.0.0")

With Carthage:

github "sindresorhus/DockProgress"

Usage

Manually set the progress

import Cocoa
import DockProgress

foo.onUpdate = { progress in
	DockProgress.progressValue = progress
}

Specify a Progress instance

import Cocoa
import DockProgress

let progress = Progress(totalUnitCount: 1)
progress?.becomeCurrent(withPendingUnitCount: 1)

DockProgress.progress = progress

Styles

It comes with two styles. PR welcome for more.

You can also draw a custom progress with .custom(drawHandler: (_ rect: CGRect) -> Void).

Bar

import DockProgress

DockProgress.style = .bar

This is the default.

Circle

import DockProgress

DockProgress.style = .circle(radius: 55, color: .systemBlue)

Make sure to set a radius that matches your app icon.

Related

  • LaunchAtLogin - Add "Launch at Login" functionality to your macOS app

License

MIT © Sindre Sorhus

About

Show progress in your app's Dock icon

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 100.0%