Class TextParagraph
Stay organized with collections
Save and categorize content based on your preferences.
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.',
);
Detailed documentation
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
| Name | Type | Description |
maxLines | Integer | The 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
| Name | Type | Description |
text | String | The text to display. |
Return
TextParagraph — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-30 UTC.
[null,null,["Last updated 2025-01-30 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eTextParagraph\u003c/code\u003e widget displays text with basic HTML formatting support.\u003c/p\u003e\n"],["\u003cp\u003eIt is usable in Google Workspace Add-ons and Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can set the displayed text using the \u003ccode\u003esetText()\u003c/code\u003e method and can chain additional methods for further customization.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetText()\u003c/code\u003e method requires a string argument representing the desired text content.\u003c/p\u003e\n"]]],["The `TextParagraph` widget displays text with basic HTML formatting in Google Workspace add-ons and Google Chat apps. Key actions include `setText(text)` to define the displayed text and `setMaxLines(maxLines)` to limit the visible lines; exceeding this limit adds a \"show more\" button. `setMaxLines` is in developer preview for Google Workspace and available for Google Chat, whereas `setText` is fully available. Both methods return the `TextParagraph` object to enable method chaining.\n"],null,["# Class TextParagraph\n\nTextParagraph\n\nA widget that displays text and supports [basic HTML formatting](/gmail/add-ons/concepts/widgets#text_formatting).\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\nconst textParagraph = CardService.newTextParagraph().setText(\n 'This is a text paragraph widget. Multiple lines are allowed if needed.',\n);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------|--------------------|----------------------------------------------------------------------------|\n| [setMaxLines(maxLines)](#setMaxLines(Integer)) | [TextParagraph](#) | Sets the maximum number of lines of text that are displayed in the widget. |\n| [setText(text)](#setText(String)) | [TextParagraph](#) | Sets the text of the paragraph. |\n\nDetailed documentation\n----------------------\n\n### `set``Max``Lines(maxLines)`\n\nSets the maximum number of lines of text that are displayed in the widget. If the text exceeds\nthe specified maximum number of lines, the excess content is concealed behind a \"show more\"\nbutton. If the text is equal or shorter than the specified maximum number of lines, a \"show\nmore\" button isn't displayed.\n\nAvailable for Google Chat apps. In developer preview for Google Workspace add-ons.\n\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.\n\n\u003cbr /\u003e\n\n```javascript\nconst textParagraph =\n CardService.newTextParagraph()\n .setText(\n 'This is a text paragraph widget. Multiple lines are allowed if needed.',\n )\n .setMaxLines(1);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|-----------|---------------------------------------------------------|\n| `max``Lines` | `Integer` | The maximum number of lines of text that are displayed. |\n\n#### Return\n\n\n[TextParagraph](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text of the paragraph. Required.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|----------------------|\n| `text` | `String` | The text to display. |\n\n#### Return\n\n\n[TextParagraph](#) --- This object, for chaining."]]
