Class TextParagraph

  • A TextParagraph is a widget that displays text and supports basic HTML formatting.

  • It is available for Google Workspace add-ons and Google Chat apps.

  • Key methods include setMaxLines() to set the maximum lines displayed and setText() to set the paragraph's text.

  • The setMaxLines() method can hide excess content behind a "show more" button if the text exceeds the limit.
TextParagraph

A widget that displays text and supports basic HTML formatting.

Available for Google Workspace add-ons and Google Chat apps. 

const textParagraph = CardService.newTextParagraph().setText(
    'This is a text paragraph widget. Multiple lines are allowed if needed.',
);

Methods

MethodReturn typeBrief description
addEventAction(eventAction)WidgetAdds the event action that can be performed on the widget.
setId(id)WidgetSets the unique ID assigned that's used to identify the widget to be mutated.
setMaxLines(maxLines)TextParagraphSets the maximum number of lines of text that are displayed in the widget.
setText(text)TextParagraphSets the text of the paragraph.
setVisibility(visibility)WidgetSets the visibility of the widget.

Detailed documentation

addEventAction(eventAction)

Adds the event action that can be performed on the widget.

Parameters

NameTypeDescription
eventActionEventActionThe EventAction to be added.

Return

Widget — The Object, for chaining.

setId(id)

Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutation is only supported in Add-Ons.

Parameters

NameTypeDescription
idStringThe id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`.

Return

Widget — This object, for chaining.

setMaxLines(maxLines)

Sets the maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a "show more" button. If the text is equal or shorter than the specified maximum number of lines, a "show more" button isn't displayed.

Available for Google Chat apps. In developer preview for Google Workspace add-ons. 

const textParagraph =
    CardService.newTextParagraph()
        .setText(
            'This is a text paragraph widget. Multiple lines are allowed if needed.',
            )
        .setMaxLines(1);

Parameters

NameTypeDescription
maxLinesIntegerThe maximum number of lines of text that are displayed.

Return

TextParagraph — This object, for chaining.

setText(text)

Sets the text of the paragraph. Required.

Parameters

NameTypeDescription
textStringThe text to display.

Return

TextParagraph — This object, for chaining.

setVisibility(visibility)

Sets the visibility of the widget. The default value is `VISIBLE`.

Parameters

NameTypeDescription
visibilityVisibilityThe Visibility of the widget.

Return

Widget — The Object, for chaining.