emojibase

Emojibase, the ultimate emoji database.

A collection of lightweight, up-to-date, pre-generated, specification compliant, localized emoji JSON datasets, regex patterns, and more.

Features

• Supports the latest Emoji 15.1, Unicode 15.1, and CLDR 44 release versions
• Built directly from the emoji data source files
• Based on the official Unicode Technical Standard #51
• With localization provided by Unicode Technical Standard #35

Documentation

https://emojibase.dev

Index

Functions

• appendSkinToneIndex
• fetchEmojis
• fetchFromCDN
• fetchMessages
• fetchShortcodes
• flattenEmojiData
• fromCodepointToUnicode
• fromHexcodeToCodepoint
• fromUnicodeToHexcode
• generateEmoticonPermutations
• joinShortcodes
• joinShortcodesToEmoji
• stripHexcode

Interfaces

• CompactEmoji
• Emoji
• EmojiLike
• FetchEmojisExpandedOptions
• FetchEmojisOptions
• FetchFromCDNOptions
• GroupDataset
• GroupMessage
• MessagesDataset
• PermutationOptions
• SkinToneMessage
• SubgroupMessage

Type Aliases

• CDNUrlFn
• CodePoint
• Emoticon
• FlatCompactEmoji
• FlatEmoji
• Gender
• GenderKey
• Group
• GroupKey
• Hexcode
• HexcodesDataset
• Locale
• LocalizedShortcodePreset
• Presentation
• PresentationKey
• Qualifier
• Shortcode
• ShortcodePreset
• ShortcodesDataset
• SkinTone
• SkinToneKey
• Subgroup
• SubgroupKey
• Unicode
• VersionDataset

Variables

• DARK_SKIN
• EMOJI
• EMOJI_VERSIONS
• EMOTICON_OPTIONS
• FEMALE
• FIRST_UNICODE_EMOJI_VERSION
• FULLY_QUALIFIED
• GROUP_KEY_ACTIVITIES
• GROUP_KEY_ANIMALS_NATURE
• GROUP_KEY_COMPONENT
• GROUP_KEY_FLAGS
• GROUP_KEY_FOOD_DRINK
• GROUP_KEY_OBJECTS
• GROUP_KEY_PEOPLE_BODY
• GROUP_KEY_SMILEYS_EMOTION
• GROUP_KEY_SYMBOLS
• GROUP_KEY_TRAVEL_PLACES
• LATEST_CLDR_VERSION
• LATEST_EMOJI_VERSION
• LATEST_UNICODE_VERSION
• LIGHT_SKIN
• MALE
• MEDIUM_DARK_SKIN
• MEDIUM_LIGHT_SKIN
• MEDIUM_SKIN
• MINIMALLY_QUALIFIED
• SEQUENCE_REMOVAL_PATTERN
• SKIN_KEY_DARK
• SKIN_KEY_LIGHT
• SKIN_KEY_MEDIUM
• SKIN_KEY_MEDIUM_DARK
• SKIN_KEY_MEDIUM_LIGHT
• SUPPORTED_LOCALES
• TEXT
• UNICODE_VERSIONS
• UNQUALIFIED

Type Aliases

CDNUrlFn

CDNUrlFn: (path: string, version: string) => string

CodePoint

CodePoint: number

Emoticon

Emoticon: string

FlatCompactEmoji

FlatCompactEmoji: Omit<CompactEmoji, skins>

FlatEmoji

FlatEmoji: Omit<Emoji, skins>

Gender

Gender: 0 | 1

GenderKey

GenderKey: female | male

Group

Group: number

GroupKey

GroupKey: activities | animals-nature | component | flags | food-drink | objects | people-body | smileys-emotion | symbols | travel-places

Hexcode

Hexcode: string

HexcodesDataset

HexcodesDataset: Record<Hexcode, Record<Hexcode, Qualifier>>

Locale

Locale: bn | da | de | en-gb | en | es-mx | es | et | fi | fr | hi | hu | it | ja | ko | lt | ms | nb | nl | pl | pt | ru | sv | th | uk | zh-hant | zh

LocalizedShortcodePreset

LocalizedShortcodePreset: `${Locale}/${ShortcodePreset}`

Presentation

Presentation: 0 | 1

PresentationKey

PresentationKey: emoji | text

Qualifier

Qualifier: 0 | 1 | 2

Shortcode

Shortcode: string

ShortcodePreset

ShortcodePreset: cldr-native | cldr | discord | emojibase-legacy | emojibase-native | emojibase | github | iamcal | joypixels | slack

ShortcodesDataset

ShortcodesDataset: Record<Hexcode, string[] | string>

SkinTone

SkinTone: 1 | 2 | 3 | 4 | 5

SkinToneKey

SkinToneKey: dark | light | medium-dark | medium-light | medium

Subgroup

Subgroup: number

SubgroupKey

SubgroupKey: alphanum | animal-amphibian | animal-bird | animal-bug | animal-mammal | animal-marine | animal-reptile | arrow | arts-crafts | av-symbol | award-medal | body-parts | book-paper | cat-face | clothing | computer | country-flag | currency | dishware | drink | emotion | event | face-affection | face-concerned | face-costume | face-glasses | face-hand | face-hat | face-negative | face-neutral-skeptical | face-sleepy | face-smiling | face-tongue | face-unwell | family | flag | food-asian | food-fruit | food-marine | food-prepared | food-sweet | food-vegetable | game | gender | geometric | hair-style | hand-fingers-closed | hand-fingers-open | hand-fingers-partial | hand-prop | hand-single-finger | hands | heart | hotel | household | keycap | light-video | lock | mail | math | medical | money | monkey-face | music | musical-instrument | office | other-object | other-symbol | person-activity | person-fantasy | person-gesture | person-resting | person-role | person-sport | person-symbol | person | phone | place-building | place-geographic | place-map | place-other | place-religious | plant-flower | plant-other | punctuation | religion | science | skin-tone | sky-weather | sound | sport | subdivision-flag | time | tool | transport-air | transport-ground | transport-sign | transport-water | warning | writing | zodiac

Unicode

Unicode: string

VersionDataset

VersionDataset: Record<string, string[]>

Variables

constDARK_SKIN

DARK_SKIN: SkinTone = 5

constEMOJI

EMOJI: Presentation = 1

constEMOJI_VERSIONS

EMOJI_VERSIONS: string[] = ...

constEMOTICON_OPTIONS

EMOTICON_OPTIONS: Record<string, PermutationOptions> = ...

constFEMALE

FEMALE: Gender = 0

constFIRST_UNICODE_EMOJI_VERSION

FIRST_UNICODE_EMOJI_VERSION: 6.0.0 = '6.0.0'

constFULLY_QUALIFIED

FULLY_QUALIFIED: Qualifier = 0

constGROUP_KEY_ACTIVITIES

GROUP_KEY_ACTIVITIES: GroupKey = 'activities'

constGROUP_KEY_ANIMALS_NATURE

GROUP_KEY_ANIMALS_NATURE: GroupKey = 'animals-nature'

constGROUP_KEY_COMPONENT

GROUP_KEY_COMPONENT: GroupKey = 'component'

constGROUP_KEY_FLAGS

GROUP_KEY_FLAGS: GroupKey = 'flags'

constGROUP_KEY_FOOD_DRINK

GROUP_KEY_FOOD_DRINK: GroupKey = 'food-drink'

constGROUP_KEY_OBJECTS

GROUP_KEY_OBJECTS: GroupKey = 'objects'

constGROUP_KEY_PEOPLE_BODY

GROUP_KEY_PEOPLE_BODY: GroupKey = 'people-body'

constGROUP_KEY_SMILEYS_EMOTION

GROUP_KEY_SMILEYS_EMOTION: GroupKey = 'smileys-emotion'

constGROUP_KEY_SYMBOLS

GROUP_KEY_SYMBOLS: GroupKey = 'symbols'

constGROUP_KEY_TRAVEL_PLACES

GROUP_KEY_TRAVEL_PLACES: GroupKey = 'travel-places'

constLATEST_CLDR_VERSION

LATEST_CLDR_VERSION: 44 = '44'

constLATEST_EMOJI_VERSION

LATEST_EMOJI_VERSION: 15.1 = '15.1'

constLATEST_UNICODE_VERSION

LATEST_UNICODE_VERSION: 15.1.0 = '15.1.0'

constLIGHT_SKIN

LIGHT_SKIN: SkinTone = 1

constMALE

MALE: Gender = 1

constMEDIUM_DARK_SKIN

MEDIUM_DARK_SKIN: SkinTone = 4

constMEDIUM_LIGHT_SKIN

MEDIUM_LIGHT_SKIN: SkinTone = 2

constMEDIUM_SKIN

MEDIUM_SKIN: SkinTone = 3

constMINIMALLY_QUALIFIED

MINIMALLY_QUALIFIED: Qualifier = 1

constSEQUENCE_REMOVAL_PATTERN

SEQUENCE_REMOVAL_PATTERN: RegExp = ...

constSKIN_KEY_DARK

SKIN_KEY_DARK: SkinToneKey = 'dark'

constSKIN_KEY_LIGHT

SKIN_KEY_LIGHT: SkinToneKey = 'light'

constSKIN_KEY_MEDIUM

SKIN_KEY_MEDIUM: SkinToneKey = 'medium'

constSKIN_KEY_MEDIUM_DARK

SKIN_KEY_MEDIUM_DARK: SkinToneKey = 'medium-dark'

constSKIN_KEY_MEDIUM_LIGHT

SKIN_KEY_MEDIUM_LIGHT: SkinToneKey = 'medium-light'

constSUPPORTED_LOCALES

SUPPORTED_LOCALES: Locale[] = ...

constTEXT

TEXT: Presentation = 0

constUNICODE_VERSIONS

UNICODE_VERSIONS: string[] = ...

constUNQUALIFIED

UNQUALIFIED: Qualifier = 2