DevDex
Explore
← BACK
@sindresorhus / DockProgress

DockProgress

Show progress in your app's Dock icon

Swift ⭐ 1357
▶ Demo </> Source

README

Open on GitHub ↗

DockProgress

Show progress in your app's Dock icon

Requirements

macOS 12+

Install

Add https://github.com/sindresorhus/DockProgress in the “Swift Package Manager” tab in Xcode.

Latest version: 5.1.0

API

See the API docs.

Usage

The snippets below are statements, so they must go inside a function (not at the top level of a file) and run on the main actor.

Manually set the progress

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

Specify a Progress instance

import Foundation
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.

Use in SwiftUI

import SwiftUI
import DockProgress

struct ContentView: View {
	@State private var progress = 0.0

	var body: some View {
		VStack {
			ProgressView(value: progress)
			Button("Start") {
				progress = 0.5
			}
		}
		.dockProgress(progress)
	}
}

Pass nil to reset the progress. By default, progress resets when the view disappears.

Styles

Includes built-in styles (bar, squircle, circle, badge, pie) plus support for custom styles using SwiftUI views or Canvas drawing.

See the example app in the Xcode project for demonstrations.

Set the style once at launch. For example, in a SwiftUI app:

import SwiftUI
import DockProgress

@main
struct MyApp: App {
	init() {
		DockProgress.style = .squircle(color: .white.opacity(0.5))
	}

	var body: some Scene {
		WindowGroup {
			ContentView()
		}
	}
}

Custom Styles

Create custom progress indicators with:

  1. SwiftUI View: .customView { progress in /* return any View */ } - Maximum flexibility with any SwiftUI view
  2. SwiftUI Canvas: .customCanvas { context, size, progress in /* draw on canvas */ } - High-performance custom drawing
  3. Legacy Core Graphics: .custom(drawHandler: (_ rect: CGRect) -> Void) - Direct Core Graphics drawing (backward compatibility)

Bar

DockProgress.style = .bar

This is the default.

Squircle

DockProgress.style = .squircle(color: .white.opacity(0.5))

Fits perfectly around macOS app icons by default. Use the inset parameter for adjustments if needed.

Circle

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

Badge

DockProgress.style = .badge(color: .blue, badgeValue: { getDownloadCount() })

Large numbers are shortened: 1012 → 1k, 10000 → 9k+.

Note: badgeValue is for counts (downloads, files, etc.), not percentages.

Pie

DockProgress.style = .pie(color: .blue)

Related