Morrantho / allmoji

A JSON document containing every emoji 12.0 character, shortname, and codepoints.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

allmoji

A JSON document containing every emoji 12.0 character, shortname, and codepoints. Allmoji now supports all twemoji emojis and provides a tiny library for looking up specific emojis by shortname.

This document exists because the standard for shortnames is a problem. There are too many deviations and variations of the same emoji with a different name. 90% of the emoji libraries out there are out of date. This document aims to maintain a consistent naming scheme as well as support all future emojis, including the upcoming emoji 13.0 2020 release. All of the data in this document was scraped from emojipedia. I merely put it into a format exclusively for developers. You will find that keys are shortnames for quick lookup, and codepoints and the emoji's character as values. Should you require any other attributes, leave your request below.

What makes allmoji different from other emoji libraries such as emojilib or even twemoji?

Fair question. Allmoji gives you the emoji's Unicode character, all its codepoints in hex and the associated twemoji image as hex. What does this do for me?

Lets compare to emojilib

emojilib gives you the emoji's unicode character which you must use in order to retrieve it's associated .png, .svg or .ai image from twemoji's API. Twemoji still needs to parse it into an image tag. With allmoji, there is no parsing. Emojis are hosted locally, just like Twemoji. The difference is there is no conversion happening. Allmoji accounts for converting to hex ahead of time to retrieve the associated twemoji image. This means faster runtime and a near constant-time lookup. Also, what if you're not writing a webapp or don't have access to javascript? Tons of languages have JSON parsing support. All you'd need to do is clone this repo and parse the JSON in your language of choice and maybe write a mini wrapper for retrieval. No matter the language you choose, you still get near constant-time lookup.

Lets compare to Twemoji

Twemoji's API does not offer parsing an emoji by its shortname because it doesn't support shortnames, but rather codepoints and unicodes to resolve an emoji. Using twemoji, you need the emoji's unicode or codepoints for it to parse the emoji. If you don't have this information, it can be difficult to work with. What if you only had emoji shortnames and needed to work on an app that supports emoji autocompletion? How would you handle that? Write a giant JSON object that contains keys of ALL emoji shortnames, where the values are the associated twemoji image? Well, enter allmoji.

API

Returns the emoji's hex character, shortname and image as a JSON object.

Allmoji.Get( shortname );

Returns the emoji's Unicode character as a string.

Allmoji.GetChar( shortname );

Returns all of the emoji's codepoints as an array of strings.

Allmoji.GetCodePoints( shortname );

Returns the emoji's twemoji image relative to the given path and extension. If you've changed the folder names, this will just be the folder's name.

Allmoji.GetImg( shortname, path, ext );

Examples:

let eggplant = Allmoji.GetImg( "eggplant", "72x72/", ".png" );
let taco     = Allmoji.GetImg( "taco", "svg/", ".svg" );
let cry      = Allmoji.GetImg( "crying_face", "ai/", ".ai" );

About

A JSON document containing every emoji 12.0 character, shortname, and codepoints.


Languages

Language:JavaScript 100.0%