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: 3 months 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 (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-31T20:47:13.000Z (3 months ago)
- Last Synced: 2025-04-02T21:46:08.975Z (3 months ago)
- Topics: swift, swiftui
- Language: Shell
- Homepage:
- Size: 2.06 MB
- Stars: 87
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# AppIconKit
AppIconKit is a Swift SDK that helps you manage alternate app icons on 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 alternate icon values for your app.
* Use `AlternateAppIconContext` to set and keep track of the current icon.
* Use `AlternateAppIconCollection` to group icons into related collections.
* Use `AlternateAppIconListItem` when listing an app icon in lits and grids.
* Use `AlternateAppIconShelf` to list app icons in a vertical list of horizontal shelves.
The context will automatically restore the icon on macOS, when a context instance is created.
> [!IMPORTANT]
> Make sure to enable `Include All App Icon Assets` in the app Info.plist for the app to be able to pick icons. You must add an `.imageset` and an `.appiconset` for each icon, since SwiftUI can't render `.appiconset`s and the OS can't use `.imageset`s as app icon.
## Documentation
The online [documentation][Documentation] has more information, articles, code examples, etc.
## Demo Application
The `Demo` folder has a demo app that lets you explore the library and try changing the app icon.
## 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]
* E-mail: [[email protected]][Email]
* Bluesky: [@[email protected]][Bluesky]
* Mastodon: [@[email protected]][Mastodon]
## 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
[Bluesky]: https://bsky.app/profile/danielsaidi.bsky.social
[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