# emojis
[![Crates.io Version](https://img.shields.io/crates/v/emojis.svg)](https://crates.io/crates/emojis)
[![Docs.rs Latest](https://img.shields.io/badge/docs.rs-latest-blue.svg)](https://docs.rs/emojis)
[![Build Status](https://img.shields.io/github/workflow/status/rossmacarthur/emojis/build/trunk)](https://github.com/rossmacarthur/emojis/actions?query=workflow%3Abuild)
โจ Lookup, iterate over, and fuzzy search for emojis.
### Features
- Lookup up emoji by Unicode value.
- Lookup up emoji by GitHub shortcode.
- Iterate over emojis in recommended order.
- Iterate over emojis in an emoji group. E.g. "Smileys & Emotion" or "Flags".
- Fuzzy search all emojis.
- Based on the latest Unicode emoji spec (v13.1).
## Examples
```rust
// lookup any emoji by Unicode value
let face = emojis::lookup("๐คจ").unwrap();
// or GitHub shortcode
let face = emojis::lookup("raised_eyebrow").unwrap();
assert_eq!(face.as_str(), "\u{1F928}");
assert_eq!(face.name(), "face with raised eyebrow");
assert_eq!(face.group(), emojis::Group::SmileysAndEmotion);
assert_eq!(face.shortcode().unwrap(), "raised_eyebrow");
// iterate over all the emojis.
let emoji = emojis::iter().next().unwrap();
assert_eq!(emoji, "๐");
// iterate over all the emojis in a group.
let emoji = emojis::Group::FoodAndDrink.emojis().next().unwrap();
assert_eq!(emoji, "๐");
// fuzzy search for emojis.
let emoji = emojis::search("rket").next().unwrap();
assert_eq!(emoji, "๐");
```
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.