winemoji v1.0.8

winemoji

Collection of utility functions wrapped around emojis supported by Windows. Built with emoji data from winmojilib package.

Installation

npm install winemoji

Usage

Variables

import { emojis } from 'winemoji';

emojis
/*
    [
        { 
            char: '😀', 
            group: 'smileys-emotion', 
            hexcode: '1F600', 
            keywords: ['face', 'grin', 'grinning face'],
            name: 'grinning_face',
            subgroup: 'face-smiling' 
        }, ...
    ]
*/

Enums

import { Groups } from 'winemoji';

Groups
/*
    {
        AnimalsAndNature = 'animals-nature',
        SmileysAndEmotion = 'smileys-emotion',
        FoodAndDrink = 'food-drink',
        ...
    }
*/

import { Subgroups } from 'winemoji';

Subgroups
/*
    {
        Drink = 'drink',
        Clothing = 'clothing',
        HairStyle = 'hair-style',
        ...
    }
*/

Functions

import { resolveEmoji } from "winemoji";

resolveEmoji("frog")
resolveEmoji("🐸")
resolveEmoji("1F438")
/*
    { 
        char: '🐸', 
        group: 'animals-nature', 
        hexcode: '1F438', 
        keywords: ['animal', 'face', 'frog'],
        name: 'frog_face',
        subgroup: 'animal-amphibian' 
    }
*/

import { getRandomEmoji } from "winemoji";

getRandomEmoji()
/*
    {
        char: '💜',
        keywords: [ 'purple', 'purple heart' ],
        name: 'purple_heart',
        group: 'smileys-emotion',
        hexcode: '1F49C',
        subgroup: 'emotion'
    }
*/

import { getSimilarEmojis } from "winemoji";

getSimilarEmojis("🍳")
/*
    [
        {
            emoji: {
                char: '🥚',
                ...
            },
            similarity: 0.4
        },
        {
            emoji: {
                char: '🥐',
                ...
            },
            similarity: 0.2
        },
        {
            emoji: {
                char: '🥯' ,
                ...
            },
            similarity: 0.2
        },
        ...
    ]
*/

import { getRandomSimilarEmoji } from "winemoji";

getRandomSimilarEmoji("🍳")
/*
    {
        emoji: {
            char: '🥚',
            ...
        },
        similarity: 0.4
    }
*/

import { getEmojisMatchingKeyword } from "winemoji";

getEmojisMatchingKeyword("ball")
/*
[
    {
        char: '⚽',
        ...
    },
    {
        char: '⚾',
        ...
    },
    {
        char: '🥎' ,
        ...
    },
    ...
]
*/

import { getEmojisMatchingKeywords } from "winemoji";

getEmojisMatchingKeywords(["chocolate","bar"])
/*
    [
        {
            char: '🍫',
            keywords: [ 'bar', 'chocolate', 'dessert', 'sweet' ],
            name: 'chocolate_bar',
            group: 'food-drink',
            hexcode: '1F36B',
            subgroup: 'food-sweet'
        }
    ]
*/

import { getEmojisFromGroup, Groups } from "winemoji";

getEmojisFromGroup(Groups.AnimalsAndNature);
/*
    [
        {
            char: '🐵',
            ...
        },
        {
            char: '🐒',
            ...
        },
        {
            char: '🦍',
            ...
        },
        ...
    ]
*/

import { getEmojisFromSubgroup, Subgroups } from "winemoji";

getEmojisFromSubgroup(Subgroups.Music);
/*
    [
        {
            char: '🎼',
            ...
        },
        {
            char: '🎵',
            ...
        },
        {
            char: '🎶',
            ...
        },
        ...
    ]
*/