emoji-data-ios

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Xcode 10 and Swift 4.2

Installation

emojidataios is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "emojidataios"

How to use it?

For now the functions from this library are quite simple. You can mostly only convert from aliases to unicode, and vice versa You can also get Emojis depending on their Category

EmojiParser

Since it takes some time to load the Emoji list, you might want to consider calling EmojiParser.prepare() when starting the app. It will load the Emoji list in a background thread, so it is ready when you need it.

Categories

There is 8 different categories, they are available through a enum named EmojiCategory

• Symbols
• Objects
• Nature
• People
• Foods
• Places
• Activity
• Flags

To get a list of Emojis depending on a category, use EmojiParser#getEmojisForCategory(EmojiCategory)

To unicode

To replace all the aliases found in a string by their unicode, use EmojiParser#parseAliases(String).

For example:

let str = "An :grinning:awesome :smiley:string :heart:with a few :wink:emojis!"
let result = EmojiParser.parseAliases(str)
print(result)
// Prints:
// "An 😀awesome 😃string ❤️with a few 😉emojis!"

To aliases

To replace all the emoji's unicodes found in a string by their aliases, use EmojiParser#parseUnicode(String).

For example:

let str = "An 😀awesome 😃string ❤️with a few 😉emojis!"
let result = EmojiParser.parseUnicode(str)
print(result)
// Prints:
// "An :grinning:awesome :smiley:string :heart:with a few :wink:emojis!"

By default, the aliases will parse and include any Skin variation that would be provided. Examples:

let str = "Here is a boy: :boy::skin-tone-6:!"
print(EmojiParser.parseAliases(str))
let str = "Here is a boy: :boy|type_6:!"
print(EmojiParser.parseAliases(str))
// Prints twice:
// "Here is a boy: 👦🏿!"

Credits

emoji-data provides the emojis for the library to work iamcal/emoji-data.

Author

Maxime Bertheau, [email protected]

License

emojidataios is available under the MIT license. See the LICENSE file for more info.

Available Emojis

Here is a table of the available emojis and their aliases.