Class CollapseControl

  • CollapseControl is a customizable control that allows users to collapse and expand content within Google Chat apps and Google Workspace Add-ons (in developer preview).

  • Developers can customize the appearance and behavior of the CollapseControl using methods to set collapse and expand buttons, as well as horizontal alignment.

  • setCollapseButton and setExpandButton methods allow for assigning custom buttons to control the expansion and collapse actions.

  • setHorizontalAlign method enables developers to control the horizontal positioning of the CollapseControl within its container.

CollapseControl

A customizable collapse and expand control.

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

const collapseButton =
    CardService.newTextButton()
        .setTextButtonStyle(CardService.TextButtonStyle.BORDERLESS)
        .setText('Collapse');

const expandButton =
    CardService.newImageButton()
        .setImageButtonStyle(CardService.ImageButtonStyle.FILLED);

const collapseControl =
    CardService.newCollapseControl()
        .setHorizontalAlign(CardService.HorizontalAlignment.END)
        .setExpandButton(expandButton)
        .setCollapseButton(collapseButton);

Methods

MethodReturn typeBrief description
setCollapseButton(button)CollapseControlSets the Button that is displayed for "show less" button.
setExpandButton(button)CollapseControlSets the Button that is displayed for "show more" button.
setHorizontalAlign(horizontalAlignment)CollapseControlSets the HorizontalAlignment of the CollapseControl.

Detailed documentation

setCollapseButton(button)

Sets the Button that is displayed for "show less" button. Optional.
Must be set together with collapse button.

const collapseButton =
    CardService.newTextButton().setText('Collapse');

const collapseControl =
    CardService.newCollapseControl()
        .setCollapseButton(collapseButton);

Parameters

NameTypeDescription
buttonButtonThe collapse button to set.

Return

CollapseControl — This object, for chaining.


setExpandButton(button)

Sets the Button that is displayed for "show more" button. Optional.
Must be set together with collapse button.

const expandButton =
    CardService.newTextButton().setText('Expand');

const collapseControl =
    CardService.newCollapseControl()
        .setExpandButton(expandButton);

Parameters

NameTypeDescription
buttonButtonThe expand button to set.

Return

CollapseControl — This object, for chaining.


setHorizontalAlign(horizontalAlignment)

Sets the HorizontalAlignment of the CollapseControl. Optional. *

const collapseControl = CardService.newCollapseControl().setHorizontalAlign(
    CardService.HorizontalAlignment.START,
);

Parameters

NameTypeDescription
horizontalAlignmentHorizontalAlignmentThe horizontal alignment of the CollapseControl widget.

Return

CollapseControl — This object, for chaining.