1.0.0 • Published 4 years ago

test-julien-marcou-bis v1.0.0

Weekly downloads
-
License
-
Repository
github
Last release
4 years ago

Unicode Emoji

Raw data for Unicode Emoji 🙂

The data are generated using the Unicode Emoji, Version 13.0 from Unicode

You can learn more about emojis at Emojipedia

👉 Demo

Here is an example of what you can achieve using this package

🔌 Installation

npm install unicode-emoji

🧰 Usage

Import

// With Typescript
import * as unicodeEmoji from 'unicode-emoji';
// With Node.js
const unicodeEmoji = require('unicode-emoji');

Retrieve emojis

unicodeEmoji.getEmojis();
[
    {
        "emoji": "😀",
        "description": "grinning face",
        "version": "1.0",
        "keywords": ["face", "grin", "grinning face"],
        "category": "face-emotion",
        "group": "smileys-emotion",
        "subgroup": "face-smiling"
    },
    {
        "emoji": "👋",
        "description": "waving hand",
        "version": "0.6",
        "keywords": ["hand", "wave", "waving"],
        "category": "face-emotion",
        "group": "people-body",
        "subgroup": "hand-fingers-open",
        "variations": [
            {
                "emoji": "👋🏻",
                "description": "waving hand: light skin tone",
                "version": "1.0"
            },
            {
                ...
            }
        ]
    },
    {
        ...
    }
]

Retrieve components

unicodeEmoji.getComponents();
{
    "skin-tone": [
        {
            "emoji": "🏻",
            "description": "light skin tone",
            "version": "1.0"
        },
        {
            ...
        }
    ],
    "hair-style": [
        {
            "emoji": "🦰",
            "description": "red hair",
            "version": "11.0"
        },
        {
            ...
        }
    ]
}

Grouping & filtering

You can group & filter emojis by category, group, subgroup or version

Here is an example :

  • grouped by category
  • without the emojis from the flags category
  • without the emojis from the 12.1 & 13.0 versions

const groupBy = 'category';
const omitWhere = { category: ['flags'], version: ['12.1', '13.0'] };

// Only omitting
unicodeEmoji.getUnicodeEmojis(omitWhere)

// Grouping and omitting
unicodeEmoji.getUnicodeEmojisGroupedBy(groupBy, omitWhere);

📋 Details

While complete data are available on GitHub :

  • unicode-emoji.csv provides complete flat data
  • unicode-emoji.json provides complete hierarchical data

Only the stripped-down unicode-emoji.min.json file is bundled within the NPM package to greatly reduce its size