Class CardSection
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
Card sections visually separate groups of widgets within Google Workspace add-ons and Chat apps.
-
They can be customized with headers and configured to be collapsible, showing a specified number of widgets when collapsed.
-
Developers can easily add widgets like images and text paragraphs to card sections using Apps Script.
-
Card sections enhance the organization and user experience by grouping related content within cards.
A card section holds groups of widgets and provides visual separation between them.
Available for Google Workspace add-ons and Google Chat apps.
constimage=CardService.newImage(); // Build image ... consttextParagraph=CardService.newTextParagraph(); // Build text paragraph ... constcardSection=CardService.newCardSection() .setHeader('Section header') .addWidget(image) .addWidget(textParagraph);
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Card | Adds the given widget to this section. |
set | Card | Sets the customizable expand and collapse buttons of the section. |
set | Card | Sets whether the section can be collapsed. |
set | Card | Sets the header of the section. |
set | Card | Sets the number of widgets that are still shown when this section is collapsed. |
Detailed documentation
addWidget(widget)
Adds the given widget to this section. Widgets are shown in the order they were added. You can't add more than 100 widgets to a card section.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | A widget to add to the section. |
Return
Card — This object, for chaining.
setCollapseControl(collapseControl)
Sets the customizable expand and collapse buttons of the section. These buttons are shown only if the section is collapsible. If this field isn't set, default buttons are used.
Available for Google Chat apps. In developer preview for Google Workspace add-ons.
constcollapseButton= CardService.newTextButton() .setTextButtonStyle(CardService.TextButtonStyle.BORDERLESS) .setText('show less'); constexpandButton= CardService.newImageButton() .setImageButtonStyle(CardService.ImageButtonStyle.FILLED) .setMaterialIcon(CardService.newMaterialIcon().setName('bug_report')); constcollapsibleSection= CardService.newCardSection() .setCollapsible(true) .setNumUncollapsibleWidgets(1) .setCollapseControl( CardService.newCollapseControl() .setHorizontalAlign(CardService.HorizontalAlignment.CENTER) .setCollapseButton(collapseButton) .setExpandButton(expandButton), );
Parameters
| Name | Type | Description |
|---|---|---|
collapse | Collapse | The collapse control setting. |
Return
Card — This object, for chaining.
setCollapsible(collapsible)
Sets whether the section can be collapsed.
Parameters
| Name | Type | Description |
|---|---|---|
collapsible | Boolean | The collapsible setting. |
Return
Card — This object, for chaining.
setHeader(header)
Sets the header of the section. Optional.
Parameters
| Name | Type | Description |
|---|---|---|
header | String | The header text. |
Return
Card — This object, for chaining.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)
Sets the number of widgets that are still shown when this section is collapsed. The widgets shown are always the first ones that were added.
Parameters
| Name | Type | Description |
|---|---|---|
num | Integer | The number of widgets to show. |
Return
Card — This object, for chaining.