Skip to main content

@slack/web-api / RichTextUsergroupMention

Interface: RichTextUsergroupMention

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

Description​

A usergroup mention 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

type​

type: "usergroup";

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

Description​

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

usergroup_id​

usergroup_id: string;

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

Description​

The encoded usergroup ID, e.g. S1234ABCD.