Skip to content

ModalView.md

Latest commit

 

History

History
188 lines (114 loc) · 3.36 KB

ModalView.md

File metadata and controls

188 lines (114 loc) · 3.36 KB

@slack/web-api / ModalView

Interface: ModalView

Defined in: node_modules/@slack/types/dist/views.d.ts:26

Extends

  • BaseView

Properties

blocks

blocks: AnyBlock[];

Defined in: node_modules/@slack/types/dist/views.d.ts:5

Description

An array of AnyBlock that defines the content of the view. Max of 100 blocks.

Inherited from

BaseView.blocks

callback_id?

optional callback_id: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:18

Description

An identifier to recognize interactions and submissions of this particular view. Don't use this to store sensitive information (use private_metadata instead). Maximum length of 255 characters.

See

Handling and responding to interactions.

Inherited from

BaseView.callback_id

clear_on_close?

optional clear_on_close: boolean;

Defined in: node_modules/@slack/types/dist/views.d.ts:49

Description

When set to true, clicking on the close button will clear all views in a modal and close it. Defaults to false.

close?

optional close: PlainTextElement;

Defined in: node_modules/@slack/types/dist/views.d.ts:38

Description

An optional PlainTextElement that defines the text displayed in the close button at the bottom-right of the view. Maximum length of 24 characters.

external_id?

optional external_id: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:20

Description

A custom identifier that must be unique for all views on a per-team basis.

Inherited from

BaseView.external_id

notify_on_close?

optional notify_on_close: boolean;

Defined in: node_modules/@slack/types/dist/views.d.ts:55

Description

Indicates whether Slack will send your app a `view_closed` event when a user clicks the close button. Defaults to false.

private_metadata?

optional private_metadata: string;

Defined in: node_modules/@slack/types/dist/views.d.ts:12

Description

String that will be sent to your app in `view_submission` and `block_actions` events. Maximum length of 3000 characters.

Inherited from

BaseView.private_metadata

submit?

optional submit: PlainTextElement;

Defined in: node_modules/@slack/types/dist/views.d.ts:44

Description

An optional PlainTextElement that defines the text displayed in the submit button at the bottom-right of the view. submit is required when an input block is within the blocks array. Max length of 24 characters.

title

title: PlainTextElement;

Defined in: node_modules/@slack/types/dist/views.d.ts:33

Description

The title that appears in the top-left of the modal. Must be a PlainTextElement with a maximum length of 24 characters.

type

type: "modal";

Defined in: node_modules/@slack/types/dist/views.d.ts:28

Description

The type of view. Set to modal for modals.