Usage

npm i emoji-platform-data

import { byTitle } from "emoji-platform-data";

console.log(byTitle["Sparkling Heart"]);
/*
{
	emoji: "💖",
	emojipedia: { "currentCldrName": "Sparkling Heart", ... },
	fluemoji: { "cldr": "sparkling heart", ... },
	gemoji: { "description": "sparkling heart", ... },
	twemoji: { "description": "Sparkling heart", ... },
	...
}
*/

emoji-platform-data combines emoji data from the following projects:

• Emojipedia
• Fluent UI / Windows ("fluemoji")
• Gemoji
• Twemoji

Each emoji supported in at least one of those projects is stored by its emoji glyph and Emojipedia title.

Explainer

📙 This documentation uses the excellent emojipedia.org as a source of information.

Emojis

An emoji is a small image represented by a glyph in text. The Unicode Standard defines which characters in text map to which emojis, as well as how combinations of emoji characters combine to more emojis. For example:

• 🔥 (fire) is represented by the string code U+1F525
• ❤️ (red heart) is represented by the string codes: U+2764 U+FE0F
• ❤️‍🔥 (heart on fire) is represented by ❤️ + a "zero-width joiner" + 🔥: U+2764 U+FE0F U+200D U+1F525

💡 Emojis are not the same as their predecessors, emoticons. Emoticons are symbols that combine traditional text characters, such as :) for "smiley" and (╯°□°)╯︵ ┻━┻ for "table flip".

🆔 Identity

The formal name, or 🆔 identity, for each emoji is standardized in Unicode. However, emojis may be associated with multiple names across different specifications. For example, 👿 can be referred to either as "Angry Face with Horns" or "Imp" depending on the source.

🔗 Keywords

In addition to their name(s), emojis commonly have related terms, or 🔗 keywords, associated with them. These keywords are not standardized and may vary drastically across the various chat applications, operating systems, and shared open source libraries that each separately implement emoji pickers.

For example, 🐙 (octopus) is defined in [email protected] -used by Bluesky and other projects- with ["animal", "creature", "ocean", "sea", "nature", "beach"].

Platforms

This project attempts to bring together the 🆔 identity and 🔗 keywords across several sources of emoji data, each defined as a "platform". Platforms include:

• Chat platforms (Discord, Slack, ...)
• Operating systems (macOS, Windows, ...)
• Open source libraries used by platforms (emoji-mart, GNOME...)

Any grouping of emoji 🆔 identity and 🔗 keywords used by consumers today can qualify as a platform.

🚀 If your platform isn't included in emoji-platform-data and doesn't have a tracking platform-support issue, please file an issue asking for it!

Why?

This is useful if you're looking to see the metadata supported for emojis in each of those platforms. For example, if you wanted to determine the keywords associated with any emoji, this would let you accumulate all the keywords across the supported platforms.

Contributors

💙 This package was templated with create-typescript-app.