Skip to main content

@slack/web-api / RichTextEmoji

Interface: RichTextEmoji

Defined in: packages/types/dist/block-kit/block-elements.d.ts:783

Description

An emoji element for use in a rich text message.

Extends

Properties

name

name: string;

Defined in: packages/types/dist/block-kit/block-elements.d.ts:791

Description

Name of emoji, without colons or skin tones, e.g. wave


style?

optional style?: object;

Defined in: packages/types/dist/block-kit/extensions.d.ts:75

bold?

optional bold?: boolean;
Description

When true, boldens the text in this element. Defaults to false.

code?

optional code?: boolean;
Description

When true, the text is preformatted in an inline code style. Defaults to `false.

italic?

optional italic?: boolean;
Description

When true, italicizes the text in this element. Defaults to false.

strike?

optional strike?: boolean;
Description

When true, strikes through the text in this element. Defaults to false.

underline?

optional underline?: boolean;
Description

When true, underlines the text in this element. Defaults to false.

Description

A limited style object for styling rich text text elements.

Inherited from

RichTextStyleable.style


type

type: "emoji";

Defined in: packages/types/dist/block-kit/block-elements.d.ts:787

Description

The type of element. In this case type is always emoji.


unicode?

optional unicode?: string;

Defined in: packages/types/dist/block-kit/block-elements.d.ts:795

Description

Lowercase hexadecimal Unicode representation of a standard emoji (not for use with custom emoji).


url?

optional url?: string;

Defined in: packages/types/dist/block-kit/block-elements.d.ts:799

Description

URL of emoji asset. Only used when sharing custom emoji across workspaces.