Skip to main content

@slack/web-api / RichTextLink

Interface: RichTextLink

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

Description​

A link element for use in a rich text message.

Extends​

Properties​

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

text?​

optional text?: string;

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

Description​

The text to link.

type​

type: "link";

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

Description​

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

unsafe?​

optional unsafe?: boolean;

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

Description​

TODO: ?

url​

url: string;

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

Description​

URL to link to.