Skip to content

pengKiina/gemoji

 
 

Repository files navigation

gemoji

Build Coverage Downloads Size

Gemoji (GitHub Emoji) contains info (category, description, names, and tags) on Emoji and GitHub “Gemoji” shortcodes.

Also includes pre-built indexes to map to between names and emoji:

Install

npm:

npm install gemoji

Use

var gemoji = require('gemoji')

console.log(gemoji)

Yields:

[
  {
    emoji: '😀',
    names: ['grinning'],
    tags: ['smile', 'happy'],
    description: 'grinning face',
    category: 'Smileys & Emotion'
  },
  {
    emoji: '😃',
    names: ['smiley'],
    tags: ['happy', 'joy', 'haha'],
    description: 'grinning face with big eyes',
    category: 'Smileys & Emotion'
  },
  {
    emoji: '😄',
    names: ['smile'],
    tags: ['happy', 'joy', 'laugh', 'pleased'],
    description: 'grinning face with smiling eyes',
    category: 'Smileys & Emotion'
  },
  {
    emoji: '😁',
    names: ['grin'],
    tags: [],
    description: 'beaming face with smiling eyes',
    category: 'Smileys & Emotion'
  },
  {
    emoji: '😆',
    names: ['laughing', 'satisfied'],
    tags: ['happy', 'haha'],
    description: 'grinning squinting face',
    category: 'Smileys & Emotion'
  },
  // …
]

Get emoji

var toEmoji = require('gemoji/name-to-emoji')

console.log(toEmoji.cat)
console.log(toEmoji.poop)

Yields:

🐱
💩

Get name

var toName = require('gemoji/emoji-to-name')

console.log(toName['🐶'])
console.log(toName['\uD83D\uDCA9'])

Yields:

dog
hankey

Supported Gemoji

See support.md.

Data

The emoji list is crawled from github/gemoji and later processed for relevant information. See its license for more information.

No images are included in this repository: the copyrighted material may or may not be available on the users computer.

Related

Disclaimer

wooorm/gemoji is not affiliated with GitHub.

License

MIT © Titus Wormer

About

Info on GitHub emoji: gemoji

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%