Skip to main content

@slack/types / RichTextText

Interface: RichTextText

Defined in: block-kit/block-elements.ts:937

Description​

A generic text element for use in a rich text message.

Extends​

Properties​

style?​

optional style?: object;

Defined in: block-kit/extensions.ts:86

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

text​

text: string;

Defined in: block-kit/block-elements.ts:945

Description​

The text to render.

type​

type: "text";

Defined in: block-kit/block-elements.ts:941

Description​

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