Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielsaidi/emojikit
EmojiKit is a Swift SDK that lets you use emojis and other emoji-based features on all major Apple platforms.
https://github.com/danielsaidi/emojikit
emoji emoji-categories emoji-picker emoji-versions emojis ios macos swift swiftui tvos visionos watchos
Last synced: 5 days ago
JSON representation
EmojiKit is a Swift SDK that lets you use emojis and other emoji-based features on all major Apple platforms.
- Host: GitHub
- URL: https://github.com/danielsaidi/emojikit
- Owner: danielsaidi
- License: mit
- Created: 2024-02-22T08:10:28.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-09T15:32:12.000Z (12 days ago)
- Last Synced: 2025-01-14T21:53:21.032Z (7 days ago)
- Topics: emoji, emoji-categories, emoji-picker, emoji-versions, emojis, ios, macos, swift, swiftui, tvos, visionos, watchos
- Language: Swift
- Homepage:
- Size: 4.62 MB
- Stars: 103
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## About EmojiKit
EmojiKit lets you use emoji-based features on all major Apple platforms (iOS, macOS, tvOS, watchOS & visionOS).
EmojiKit has all you need to work with emojis, including categories, support for localization & skin tones, unicode & version information, as well as convenient ``EmojiGrid`` and ``EmojiScrollGrid`` components for SwiftUI.
## Installation
EmojiKit can be installed with the Swift Package Manager:
```
https://github.com/danielsaidi/EmojiKit.git
```
## Features
EmojiKit provides a bunch of emoji-specific features:
* 😀 Emojis - EmojiKit defines a structured emoji model.
* 🐻 Emoji Categories - EmojiKit defines all standard emoji categories.
* 📦 Emoji Versions - EmojiKit defines all emoji versions and their emojis.
* 🧩 Extensions - EmojiKit extends native types with emoji support.
* 🇸🇪 Localization - EmojiKit supports localizing all emojis and categories.
* 👍🏾 Skin Tones - EmojiKit provides emoji skin tone information.
* 🖼️ Views - EmojiKit has emoji-specific views, like grids and pickers.
See the online [documentation][Documentation] for more information.
## Getting started
The `Emoji` model can be used to parse a bunch of emoji-specific information, for instance:
```swift
Emoji("👍").unicodeIdentifier // \\N{THUMBS UP SIGN}
Emoji("🚀").unicodeIdentifier // \\N{ROCKET}
Emoji("👍").unicodeName // Thumbs Up Sign
Emoji("👍🏿").unicodeName // Thumbs Up Sign
Emoji("🚀").unicodeName // Rocket
Emoji("😀").localizedName // Grinning Face
Emoji("😀").localizedName(for: .swedish) // Leende Ansikte
Emoji("👍").hasSkinToneVariants // true
Emoji("🚀").hasSkinToneVariants // false
Emoji("👍🏿").neutralSkinToneVariant // 👍
Emoji("👍").skinToneVariants // 👍👍🏻👍🏼👍🏽👍🏾👍🏿
```
The `EmojiCategory` enum defines standard and custom categories and their emojis, for instance:
```swift
EmojiCategory.smileysAndPeopleChars.emojis // 😀😃😄...
EmojiCategory.animalsAndNatureChars.emojis // 🐶🐱🐭...
EmojiCategory.foodAndDrinkChars.emojis // 🍏🍎🍐...
```
The `EmojiVersion` enum defines Emoji versions and the emojis they introduced, for instance:
```swift
EmojiVersion.v15_1.emojis // 🙂↕️🙂↔️👩🦽➡️...
EmojiVersion.v15.emojis // 🫨🫸🫷
EmojiVersion.v14.emojis // 🫠🫢🫣
```
See the online [documentation][Documentation] for more information.
## Documentation
The online [documentation][Documentation] has more information, articles, code examples, etc.
## Demo Application
The `Demo` folder has an app that lets you explore the library.
## 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 if you want to contribute in any way:
* Website: [danielsaidi.com][Website]
* Mastodon: [@[email protected]][Mastodon]
* Twitter: [@danielsaidi][Twitter]
* E-mail: [[email protected]][Email]
## License
EmojiKit 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/EmojiKit
[License]: https://github.com/danielsaidi/EmojiKit/blob/main/LICENSE