Skip to main content

Emoji

Index

Properties

emoji

emoji: string

Emoji presentation unicode character.

optionalemoticon

emoticon?: string | string[]

If applicable, an emoticon representing the emoji character.

optionalgender

gender?: Gender

If applicable, the gender of the emoji character. 0 for female, 1 for male.

optionalgroup

group?: number

The categorical group the emoji belongs to. Undefined for uncategorized emojis.

hexcode

hexcode: string

The hexadecimal representation of the emoji Unicode codepoint. If the emoji supports both emoji and text variations, the hexcode will not include the variation selector. If a multi-person, multi-gender, or skin tone variation, the hexcode will include zero width joiners and variation selectors.

label

label: string

A localized description, provided by CLDR, primarily used for text-to-speech (TTS) and accessibility.

optionalorder

order?: number

The order in which emoji should be displayed on a device, through a keyboard or emoji picker. Undefined for unordered emojis.

optionalshortcodes

shortcodes?: string[]

List of shortcodes without surrounding colons.

optionalskins

skins?: Emoji[]

If applicable, an array of emoji objects for each skin tone modification, starting at light skin, and ending with dark skin. Also includes multi-skin tones.

optionalsubgroup

subgroup?: number

The categorical subgroup the emoji belongs to. Undefined for uncategorized emojis.

optionaltags

tags?: string[]

An array of localized keywords, provided by CLDR, to use for searching and filtering.

text

text: string

Text presentation unicode character.

optionaltone

tone?: SkinTone | SkinTone[]

If applicable, the skin tone of the emoji character. 1 for light skin, 2 for medium-light skin, 3 for medium skin, 4 for medium-dark skin, and 5 for dark skin. Multi-person skin tones will be an array of values.

type

The default presentation of the emoji character. 0 for text, 1 for emoji.

version

version: number

Version the emoji was added.