Views

Views are app-customised UI surfaces inside Slack — the contents of a modal dialog or the App Home tab.

• ModalView — content of a modal opened with views.open / views.update / views.push.
• HomeTabView — content of the App Home tab, published with views.publish.

Pass view.to_dict() as the view argument to the Slack SDK's view methods.

Slack reference: https://api.slack.com/reference/surfaces/views

Views are app-customized visual areas within modals and Home tabs.

See: https://api.slack.com/reference/surfaces/views.

HomeTabView

HomeTabViews are used with the views.publish Web API method.

See: https://api.slack.com/reference/surfaces/views#home.

Parameters:

Name	Type	Description	Default
blocks	Block | list[Block]	A list of blocks that defines the content of the view (max 100).	required
private_metadata	str | None	a string (max 3000 chars) that will be sent to your app in view_submission.	None
callback_id	str | None	A string that will identify submissions of this view.	None
external_id	str | None	A custom identifier that is unique within the views of a given Slack team.	None

Source code in slackblocks/views.py

class HomeTabView(View):
    """
    `HomeTabViews` are used with the `views.publish` Web API method.

    See: <https://api.slack.com/reference/surfaces/views#home>.

    Args:
        blocks: A list of blocks that defines the content of the view (max 100).
        private_metadata: a string (max 3000 chars) that will be sent to your app
            in `view_submission`.
        callback_id: A string that will identify submissions of this view.
        external_id: A custom identifier that is unique within the views of a
            given Slack team.
    """

    def __init__(
        self,
        blocks: Block | list[Block],
        private_metadata: str | None = None,
        callback_id: str | None = None,
        external_id: str | None = None,
    ) -> None:
        super().__init__(
            type=ViewType.HOME,
            blocks=blocks,
            private_metadata=private_metadata,
            callback_id=callback_id,
            external_id=external_id,
        )

ModalView

Modal views are used with the views.open, views.update and views.push Slack Web API methods.

See: https://api.slack.com/reference/surfaces/views#modal

Parameters:

Name	Type	Description	Default
title	TextLike	heading that appears at the top left of the view.	required
blocks	Block | list[Block]	a list of blocks (max 100) that define the content of the view.	required
close	TextLike | None	the text of the close button (max 24 chars) in the view. Must be Text.PLAINTEXT.	None
submit	TextLike | None	the text of the submit button (max 24 chars) in the view. Must be Text.PLAINTEXT.	None
private_metadata	str | None	a string (max 3000 chars) that will be sent to your app in view_submission.	None
callback_id	str | None	A string that will identify submissions of this view.	None
clear_on_close	bool | None	when True all views in the model will be cleared when it is closed.	False
notify_on_close	bool | None	when True a view_closed event will be sent when the modal is closed.	False
external_id	str | None	A custom identifier that is unique within the views of a given Slack team.	None
submit_disabled	bool | None	when True disabled submitting the form until one or more inputs have been provided. Used only for configuaration models.	False

Source code in slackblocks/views.py

class ModalView(View):
    """
    Modal views are used with the `views.open`, `views.update` and `views.push`
        Slack Web API methods.

    See: <https://api.slack.com/reference/surfaces/views#modal>

    Args:
        title: heading that appears at the top left of the view.
        blocks: a list of blocks (max 100) that define the content of the view.
        close: the text of the close button (max 24 chars) in the view.
            Must be `Text.PLAINTEXT`.
        submit: the text of the submit button (max 24 chars) in the view.
            Must be `Text.PLAINTEXT`.
        private_metadata: a string (max 3000 chars) that will be sent to your app
            in `view_submission`.
        callback_id: A string that will identify submissions of this view.
        clear_on_close: when `True` all views in the model will be cleared when
            it is closed.
        notify_on_close: when `True` a `view_closed` event will be sent when the
            modal is closed.
        external_id: A custom identifier that is unique within the views of a
            given Slack team.
        submit_disabled: when `True` disabled submitting the form until one or
            more inputs have been provided. Used only for
            [`configuaration models`](https://api.slack.com/reference/workflows/configuration-view).
    """

    def __init__(
        self,
        title: TextLike,
        blocks: Block | list[Block],
        close: TextLike | None = None,
        submit: TextLike | None = None,
        private_metadata: str | None = None,
        callback_id: str | None = None,
        clear_on_close: bool | None = False,
        notify_on_close: bool | None = False,
        external_id: str | None = None,
        submit_disabled: bool | None = False,
    ) -> None:
        super().__init__(
            type=ViewType.MODAL,
            blocks=blocks,
            private_metadata=private_metadata,
            callback_id=callback_id,
            external_id=external_id,
        )
        self.title = Text.to_text_nonnull(title, force_plaintext=True, max_length=24)
        self.close = Text.to_text(close, force_plaintext=True, max_length=24, allow_none=True)
        self.submit = Text.to_text(submit, force_plaintext=True, max_length=24, allow_none=True)
        self.clear_on_close = clear_on_close
        self.notify_on_close = notify_on_close
        self.submit_disabled = submit_disabled

    def _resolve(self) -> dict[str, Any]:
        return resolve(
            {
                **super()._resolve(),
                "title": self.title,
                "close": self.close if self.close else None,
                "submit": self.submit if self.submit else None,
                "clear_on_close": self.clear_on_close if self.clear_on_close else None,
                "notify_on_close": self.notify_on_close if self.notify_on_close else None,
                "submit_disabled": self.submit_disabled if self.submit_disabled else None,
            }
        )