emojilib Documentation

In current versions, emojilib focuses strictly on the keyword mapping. Other metadata (like categories, skin tone support, and ordering) has been moved to the unicode-emoji-json package.

To reconstruct the full emoji dataset, you must merge the keywords from emojilib with the metadata from unicode-emoji-json.

var data = require('unicode-emoji-json')
var keywordSet = require('emojilib')

for (const emoji in data) {
  data[emoji]['keywords'] = keywordSet[emoji]
}

// Now data[emoji] contains both unicode metadata and emojilib keywords

Install the emojilib package using npm to add emoji keyword search capabilities to your project.

npm install emojilib --save

If you are migrating from 2.x, note that the following data is no longer provided by emojilib and must be sourced from unicode-emoji-json:

• Ordered emoji list: Use require('unicode-emoji-json/data-ordered-emoji').
• Skin tone modifiers (Fitzpatrick scale): Use require('unicode-emoji-json/data-emoji-components').
• Skin tone support flags: Check the skin_tone_support property on the emoji object within unicode-emoji-json.