https://github.com/danielsaidi/appiconkit

AppIconKit helps you manage alternate app icons on macOS and iOS.
https://github.com/danielsaidi/appiconkit

swift swiftui

Last synced: about 8 hours ago
JSON representation

AppIconKit helps you manage alternate app icons on macOS and iOS.

• Host: GitHub
• URL: https://github.com/danielsaidi/appiconkit
• Owner: danielsaidi
• License: mit
• Created: 2024-11-22T12:54:59.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-03T17:34:09.000Z (about 1 month ago)
• Last Synced: 2025-01-07T13:26:08.752Z (8 days ago)
• Topics: swift, swiftui
• Language: Swift
• Homepage:
• Size: 1.8 MB
• Stars: 27
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


    





    

    

    

    

    



## About AppIconKit

AppIconKit helps you manage alternate app icons on both macOS and iOS.

## Installation

AppIconKit can be installed with the Swift Package Manager:

```

https://github.com/danielsaidi/AppIconKit.git

```

## Getting Started

AppIconKit helps you manage alternate app icons on both macOS and iOS.

The SDK has a couple of central types:

* Use `AlternateAppIcon` to create a list of all alternate icons in your app. 

* Use `AlternateAppIcon.Collection` to create icon collections.

* Use an `AlternateAppIconContext` to keep track of the selected icon.

You can easily create a `LazyVGrid` picker with icons, or use an `AlternateAppIcon.Shelf`:



    



You can also use the context's `setAlternateAppIcon(...)` to set an icon with code.

> [!IMPORTANT]  

> Make sure to enable `Include All App Icon Assets` in the app's Info.plist for the app to be able to select icons. Also note that you must add both an `.imageset` and an `.appiconset` for each icon, since SwiftUI can't render `.appiconset`.   

## Documentation & Demo app

This library will get a proper documentation once it gets more than 100 stars. Until then, check out the getting-started guide above and the demo app below.

## Demo app

The demo app lets you explore the library. To try it out, just open and run the `Demo` project.

## Support my work 

You can [sponsor me][Sponsors] on GitHub Sponsors or [reach out][Email] for paid support, to help support my [open-source projects][OpenSource].

Your support makes it possible for me to put more work into these projects and make them the best they can be.

## Contact

Feel free to reach out if you have questions or want to contribute in any way:

* Website: [danielsaidi.com][Website]

* Mastodon: [@[email protected]][Mastodon]

* Twitter: [@danielsaidi][Twitter]

* E-mail: [[email protected]][Email]

## License

AppIconKit is available under the MIT license. See the [LICENSE][License] file for more info.

[Email]: mailto:[email protected]

[Website]: https://danielsaidi.com

[GitHub]: https://github.com/danielsaidi

[Twitter]: https://twitter.com/danielsaidi

[Mastodon]: https://mastodon.social/@danielsaidi

[OpenSource]: https://danielsaidi.com/opensource

[Sponsors]: https://github.com/sponsors/danielsaidi

[Documentation]: https://danielsaidi.github.io/AppIconKit

[Getting-Started]: https://danielsaidi.github.io/AppIconKit/documentation/appiconkit/getting-started

[License]: https://github.com/danielsaidi/AppIconKit/blob/master/LICENSE