Negareh Emoji Library
Character information and metadata for Unicode emoji.
> If you are viewing this repository on GitHub, this GitHub repository is a mirror of the Negareh Emoji Library,
> the main repository is served on
>GitLab, all developments and
>discussions, issue tracking and merge requests take place in GitLab.
> This project is a fork of Gemoji.
## Negareh Emoji Library
This library contains character information about native emojis.
### Installation
Add `negarmoji` to your Gemfile.
``` ruby
gem 'negarmoji'
```
### Example Rails Helper
This would allow emojifying content such as: `it's raining :cat:s and :dog:s!`
See the [Emoji cheat sheet](http://www.emoji-cheat-sheet.com) for more examples.
```ruby
module EmojiHelper
def emojify(content)
h(content).to_str.gsub(/:([\w+-]+):/) do |match|
if emoji = Emoji.find_by_alias($1)
%(
)
else
match
end
end.html_safe if content.present?
end
end
```
### Unicode mapping
Translate emoji names to unicode and vice versa.
```ruby
>> Emoji.find_by_alias("cat").raw
=> "🐱" # Don't see a cat? That's U+1F431.
>> Emoji.find_by_unicode("\u{1f431}").name
=> "cat"
```
### Adding new emoji
You can add new emoji characters to the `Emoji.all` list:
```ruby
emoji = Emoji.create("music") do |char|
char.add_alias "song"
char.add_unicode_alias "\u{266b}"
char.add_tag "notes"
end
emoji.name #=> "music"
emoji.raw #=> "♫"
emoji.image_filename #=> "unicode/266b.png"
# Creating custom emoji (no Unicode aliases):
emoji = Emoji.create("music") do |char|
char.add_tag "notes"
end
emoji.custom? #=> true
emoji.image_filename #=> "music.png"
```
As you create new emoji, you must ensure that you also create and put the images
they reference by their `image_filename` to your assets directory.
You can customize `image_filename` with:
```ruby
emoji = Emoji.create("music") do |char|
char.image_filename = "subdirectory/my_emoji.gif"
end
```
For existing emojis, you can edit the list of aliases or add new tags in an edit block:
```ruby
emoji = Emoji.find_by_alias "musical_note"
Emoji.edit_emoji(emoji) do |char|
char.add_alias "music"
char.add_unicode_alias "\u{266b}"
char.add_tag "notes"
end
Emoji.find_by_alias "music" #=> emoji
Emoji.find_by_unicode "\u{266b}" #=> emoji
```
## Contribution
If you want to contribute to this project, please read [CONTRIBUTING](CONTRIBUTING.md).
## Code of Conduct
Visit the [Code of Conduct](CODE_OF_CONDUCT.md).
## Roadmap
Visit the [Roadmap](ROADMAP.md) to keep track of which features we are currently
working on.
## License
Licensed under the [GPLv3](LICENSE).
## Attribution
1. This project is a fork of [Gemoji](https://github.com/github/gemoji). License: MIT