/node-emojis

Emojis that you can use in your application 😊

Primary LanguageJavaScriptMIT LicenseMIT

npm npm bundle size Build Status Coverage Status

node-emojis

Emojis that you can use in your application 😊

Goal

The goal of the project is to support all of the emojis that can be found at Emojipedia.

Support Status

Below is a table of the emojis that are supported by version. There may be some emojis that are supported in the different versions, but there hasn't been a concerted effort to add all emojis from that version.

Verison Status
Emoji 1.0 In development 🙂
Emoji 2.0 Not supported yet 🙁
Emoji 3.0 Not supported yet 🙁
Emoji 4.0 Not supported yet 🙁
Emoji 5.0 Not supported yet 🙁
Emoji 11.0 Not supported yet 🙁
Emoji 12.0 Not supported yet 🙁

Installation

npm install node-emojis

Usage

Just import the emojis into your app. It is an object with the emoji name as the key and the actual emoji as the value.

Sample usage:

const emojis = require('node-emojis')

console.log(emojis.smile)

Output should be 😄

Supported emojis

Supported emojis can be found in different files using the table below:

Category Filename
🐈 Animal animal-emojis.js
🍔 Food food-emojis.js
🔥 Nature nature-emojis.js
🙃 People people-emojis.js
🗻 Travel travel-emojis.js

If there is an emoji that you need and is not available, please file an issue or create a pull request.

Tests

npm test

Contributing

Pull requests are welcome! It's super easy to add new emojis! Just go to https://github.com/jesselpalmer/node-emojis/tree/master/lib/emojis and if you find emojis that are missing from Emojipedia just create a PR adding the missing emoji.

Please ensure that any new or changed functionality needs unit tests accompanied with the PR. Make sure that you lint (npm run lint) and test your code (npm test).