Interface: ModalView
Extends
BaseView
Properties
blocks
blocks: AnyBlock[];
Description
An array of AnyBlock that defines the content of the view. Max of 100 blocks.
Inherited from
BaseView.blocks
Defined in
callback_id?
optional callback_id: string;
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
Defined in
clear_on_close?
optional clear_on_close: boolean;
Description
When set to true, clicking on the close button will clear all views in a modal and close it.
Defaults to false.
Defined in
close?
optional close: PlainTextElement;
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.
Defined in
external_id?
optional external_id: string;
Description
A custom identifier that must be unique for all views on a per-team basis.
Inherited from
BaseView.external_id
Defined in
notify_on_close?
optional notify_on_close: boolean;
Description
Indicates whether Slack will send your app a
view_closed event when a user
clicks the close button. Defaults to false.
Defined in
private_metadata?
optional private_metadata: string;
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
Defined in
submit?
optional submit: PlainTextElement;
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.
Defined in
title
title: PlainTextElement;
Description
The title that appears in the top-left of the modal. Must be a PlainTextElement with a maximum length of 24 characters.
Defined in
type
type: "modal";
Description
The type of view. Set to modal for modals.