Effortless emoji-querying in Swift
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
EmojiKit.xcodeproj
EmojiKit
.gitignore
AllEmoji.json
EmojiKit.podspec
LICENSE
README.md

README.md

EmojiKit

EmojiKit is a simple emoji-querying framework in Swift. It is used in Paste, an Emoji Search app in the App Store.

Installation

If you’re using Carthage, add EmojiKit to your Cartfile:

github "dasmer/EmojiKit"

Otherwise, if you're using CocoaPods, add EmojiKit to your Podfile:

pod 'EmojiKit', '~> 0.0.1'

Usage

1. Create an EmojiFetcher instance variable.
let fetcher = EmojiFetcher()
2. Use EmojiFetcher's query function to get an array of Emoji structs that match the given search string.
fetcher.query("food") { emojiResults in
  for emoji in emojiResults {
    print("Current Emoji: \(emoji.character) \(emoji.name)")
  }
}

Contributing

The best way to contribute is by submitting a pull request. You can also submit a new Github issue if you find bugs or have questions. :octocat:

Please make sure to follow the general coding style and add test coverage for new features!