Skip to main content

Interface: RichTextLink

Description​

A link element for use in a rich text message.

Extends​

Properties​

style?​

optional style: object;

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.

Description​

A limited style object for styling rich text text elements.

Inherited from​

RichTextStyleable.style

Defined in​

block-kit/extensions.ts:86

text?​

optional text: string;

Description​

The text to link.

Defined in​

block-kit/block-elements.ts:805

type​

type: "link";

Description​

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

Defined in​

block-kit/block-elements.ts:801

unsafe?​

optional unsafe: boolean;

Description​

TODO: ?

Defined in​

block-kit/block-elements.ts:809

url​

url: string;

Description​

URL to link to.

Defined in​

block-kit/block-elements.ts:813