Skip to main content

CompactEmoji

Hierarchy

  • Pick<Emoji, emoticon | group | hexcode | label | order | shortcodes | tags>
    • CompactEmoji

Index

Properties

Properties

optionalemoticon

emoticon?: string | string[]

If applicable, an emoticon representing the emoji character.

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?: CompactEmoji[]

List of skin tones as emoji objects.

optionaltags

tags?: string[]

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

unicode

unicode: string

Either the emoji or text presentation Unicode character.