Class ChipList

  • A ChipList holds a set of Chip objects displayed in a row, wrapping to the next line or allowing horizontal scrolling.

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

  • Key methods include addChip(chip) to add chips and setLayout(layout) to set the display layout.
ChipList

Holds a set of Chip objects that are displayed in a row, wrapping to the next line to horizontal scrollable.

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

const chip = CardService.newChip();
// Finish building the text chip...

const chipList = CardService.newChipList()
                     .setLayout(CardService.ChipListLayout.WRAPPED)
                     .addChip(chip);

Methods

MethodReturn typeBrief description
addChip(chip)ChipListAdds a chip.
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.
setLayout(layout)ChipListSets the chip list layout.
setVisibility(visibility)WidgetSets the visibility of the widget.

Detailed documentation

addChip(chip)

Adds a chip.

Parameters

NameTypeDescription
chipChipThe chip to add.

Return

ChipList — This object, for chaining.

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.

setLayout(layout)

Sets the chip list layout. If unset, it defaults to ChipListLayout.WRAPPED layout. 

const chip = CardService.newChip();
// Finish building the text chip...

const chipList =
    CardService.newChipList()
        .setLayout(CardService.ChipListLayout.HORIZONTAL_SCROLLABLE)
        .addChip(chip);

Parameters

NameTypeDescription
layoutChipListLayoutThe chip list layout.

Return

ChipList — 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.