Skip to main content

Interface: MrkdwnOption

Extends

  • OptionDescriptor

Properties

description?

optional description: PlainTextElement;

Description

A PlainTextElement that defines a line of descriptive text shown below the text field. Maximum length for the text within this field is 75 characters.

Inherited from

OptionDescriptor.description

Defined in

block-kit/composition-objects.ts:85


text

text: MrkdwnElement;

Description

A MrkdwnElement that defines the text shown in the option on the menu. To be used with radio buttons and checkboxes. Maximum length for the text in this field is 75 characters.

Defined in

block-kit/composition-objects.ts:93


url?

optional url: string;

Description

Only available in overflow menus! A URL to load in the user's browser when the option is clicked. Maximum length for this field is 3000 characters.

Inherited from

OptionDescriptor.url

Defined in

block-kit/composition-objects.ts:80


value?

optional value: string;

Description

A unique string value that will be passed to your app when this option is chosen. Maximum length for this field is 75 characters.

Inherited from

OptionDescriptor.value

Defined in

block-kit/composition-objects.ts:75