https://github.com/jesselpalmer/node-emojis

Emojis that you can use in your application 😊
https://github.com/jesselpalmer/node-emojis

emojis

Last synced: 11 days ago
JSON representation

Emojis that you can use in your application 😊

• Host: GitHub
• URL: https://github.com/jesselpalmer/node-emojis
• Owner: jesselpalmer
• License: mit
• Created: 2019-08-11T18:16:23.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-11-10T16:49:18.000Z (12 months ago)
• Last Synced: 2024-10-06T10:41:39.700Z (about 1 month ago)
• Topics: emojis
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/node-emojis
• Size: 458 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/dw/node-emojis.svg)](https://www.npmjs.com/package/node-emojis)

[![npm bundle size](https://img.shields.io/bundlephobia/min/node-emojis?color=%234DC92A&label=size)](https://bundlephobia.com/result?p=node-emojis)

[![Build Status](https://travis-ci.org/jesselpalmer/node-emojis.svg?branch=master)](https://travis-ci.org/jesselpalmer/node-emojis)

[![Coverage Status](https://coveralls.io/repos/github/jesselpalmer/node-emojis/badge.svg?branch=master)](https://coveralls.io/github/jesselpalmer/node-emojis?branch=master)

# 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](https://emojipedia.org/).

## 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

  ```bash

  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:

  ```js

  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](https://github.com/jesselpalmer/node-emojis/issues) or create a [pull request](https://github.com/jesselpalmer/node-emojis/pulls).

  

## Tests

  ```bash

  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](https://github.com/jesselpalmer/node-emojis/tree/master/lib/emojis) and if you find emojis that are missing from [Emojipedia](https://emojipedia.org/) 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`).