Skip to content

Latest commit

 

History

History
171 lines (112 loc) · 3.63 KB

README.md

File metadata and controls

171 lines (112 loc) · 3.63 KB
Raw

Smile

Emoji in Swift. For reference, go to https://github.com/onmyway133/emoji

CI Status Version Carthage Compatible License Platform Swift

Features

  • Support emoji sequences
  • Handle skin tones, marks, genders, variation selectors
  • Support new iOS emojis

List

List all emojis

Smile.list()
emojiList
emojiCategories

Emoji

Check if a character is emoji

Smile.isEmoji(character: "🎉") // true

Check if a string contains any emoji

Smile.containsEmoji(string: "🎈 and 🎁") // true

Get emoji from unicode values

XCTAssertEqual(Smile.emoji(unicodeValues: [0x1F47B]), "👻")
XCTAssertEqual(Smile.emoji(unicodeValues: [0x0001F468, 0x200D, 0x2708]), "👨‍✈")

Unmodify an emoji

Smile.unmodify(emoji: "👨🏿") // 👨

Name

Show standard name of an emoji

Smile.name(emoji: "🇳🇴") // ["REGIONAL INDICATOR SYMBOL LETTER N", "REGIONAL INDICATOR SYMBOL LETTER O"])

Search emoji by keywords

Smile.emojis(keywords: ["GRINNING"]) // 😁, 😸

Flag

Search emoji flag by country code

Smile.emoji(countryCode: "no") // 🇳🇴

Alias

Search emoji by alias

Emoji data is from https://github.com/github/gemoji/blob/master/db/emoji.json

Smile.emoji(alias: "japanese_castle") // 🏯

Find alias by emoji

Smile.alias(emoji: "🏯") // japanese_castle

Replace alias within a string

Smile.replaceAlias(string: ":santa: is coming to :european_castle:") // 🎅 is coming to 🏰

Category

Find category of emoji

Emoji data is from https://github.com/github/gemoji/blob/master/db/Category-Emoji.json

Smile.category(emoji: "😁") // people

Manipulation

Extract all emojis within a string

Smile.extractEmojis(string: "Find 🔑and🔎") // 🔑🔎

Remove all emojis within a string

Smile.removeEmojis(string: "Find 🔑and🔎") // Find and

Assemble

Smile.assemble(emojis: ["👨", "🏫") // 👨‍🏫
Smile.assemble(emojis: ["👨", "👩", "👧", "👦"] // 👨‍👩‍👧‍👦

Disassemble

Smile.disassemble(emoji: "👨‍🏫") // [👨, 🏫]

Script

Update emoji list by running

node parser.js

Installation

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

pod 'Smile'

Smile is also available through Carthage. To install just write into your Cartfile:

github "onmyway133/Smile"

Author

Khoa Pham, onmyway133@gmail.com

Contributing

We would love you to contribute to Smile, check the CONTRIBUTING file for more info.

License

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