How do I change the color of the DockProgress bar style?

DockProgress allows color customization through style parameters; for example, use DockProgress.style = .bar(color: .red) to set a red bar. Refer to the API docs for other styles like squircle or circle that accept color arguments.

Can I use DockProgress with AppKit apps, not just SwiftUI?

Yes, DockProgress works with both AppKit and SwiftUI apps. The README shows manual progress setting with import DockProgress and DockProgress.progress = value, making it compatible with traditional macOS development.

Is there a way to animate DockProgress indicator smoothly?

DockProgress handles animation internally for built-in styles, but for custom styles using SwiftUI views or Canvas, you can add animations within your drawing code. However, fine control over animation timing isn't explicitly documented.

DockProgress or custom NSDockTile implementation for progress indicators?

DockProgress is better for quick, native progress with multiple styles and SwiftUI integration, saving development time. A custom NSDockTile approach offers more control but requires manual drawing and more code, as hinted in the README's custom style options.

How to handle multiple progress instances with DockProgress?

DockProgress supports a single progress instance at a time via DockProgress.progress or DockProgress.progressInstance. For multiple tasks, manage them externally and update the DockProgress value accordingly, as shown in the usage examples.

Open-Awesome

DockProgress

MITSwift5.1.0

A Swift library to display progress indicators directly in your macOS app's Dock icon.

Visit Website GitHub

1.3k stars61 forks0 contributors

What is DockProgress?

DockProgress is a Swift library that allows macOS developers to display progress indicators directly in their application's Dock icon. It solves the problem of providing users with task progress feedback without cluttering the application's main interface. The library offers multiple visual styles and integrates seamlessly with both SwiftUI and traditional AppKit development.

Target Audience

macOS developers building applications that need to show progress for long-running tasks like downloads, file processing, or data synchronization.

Value Proposition

Developers choose DockProgress because it provides a native macOS experience with minimal code, offers multiple built-in visual styles, and integrates easily with both SwiftUI and traditional Swift development patterns.

Overview

Show progress in your app's Dock icon

Use Cases

Best For

Showing download progress in file management apps
Displaying processing status in media editing applications
Indicating sync progress in cloud storage clients
Showing installation progress in software updaters
Providing task completion feedback in productivity apps
Creating custom Dock icon animations for macOS utilities

Not Ideal For

Cross-platform applications that need progress indicators on multiple operating systems beyond macOS
Projects where progress must be displayed solely within the application's main window, not in the Dock
Apps targeting macOS versions older than 12, as it requires macOS 12+ for compatibility
Applications needing complex, non-progress-related Dock icon animations or modifications

Pros & Cons

Pros

Multiple Built-in Styles

Offers bar, squircle, circle, badge, and pie styles out of the box, providing visual variety without extra coding, as demonstrated in the README with GIF examples and code snippets.

Seamless SwiftUI Integration

Includes a .dockProgress() view modifier that simplifies adding progress indicators in SwiftUI apps, allowing easy binding to state variables for automatic updates.

Flexible Customization Options

Supports custom styles using SwiftUI views, Canvas drawing, or Core Graphics, enabling developers to create tailored progress indicators, as detailed in the custom style section of the README.

Automatic Progress Management

Binds to Foundation's Progress instances for automatic updates and resets progress when views disappear, reducing manual cleanup effort and potential errors.

Cons

macOS Version Restriction

Only supports macOS 12 and above, excluding applications that must run on older macOS versions, as stated in the requirements section of the README.

Weak Progress Instance Handling

The Progress instance is weakly stored, requiring developers to manually retain it to avoid losing updates, which adds complexity and risk of bugs, as noted in the API usage.

Limited Badge Functionality

The badge style is designed for counts and shortens large numbers (e.g., 1012 to 1k), but it cannot display percentages, restricting its use for certain progress scenarios, as mentioned in the README notes.

Frequently Asked Questions

Related Projects

SkeletonView

☠️ An elegant way to show users that something is happening and also prepare them to which contents they are awaiting

Stars12,883

Forks1,126

Last commit20 days ago

Material

A UI/UX framework for creating beautiful applications.

Stars11,999

Forks1,258

Last commit4 years ago

NVActivityIndicatorView

A collection of awesome loading animations

Stars10,709

Forks1,158

Last commit3 months ago

Macaw

Powerful and easy-to-use vector graphics Swift library with SVG support

Stars6,046

Forks569

Last commit2 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub