Class ChipList
Stay organized with collections
Save and categorize content based on your preferences.
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);
Detailed documentation
addChip(chip)
Adds a chip.
Parameters
| Name | Type | Description |
chip | Chip | The chip to add. |
Return
ChipList — 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
Return
ChipList — 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\u003eChipList displays a set of Chip objects in a row, wrapping to the next line or horizontally scrolling.\u003c/p\u003e\n"],["\u003cp\u003eIt's available for Google Chat apps and in developer preview for Google Workspace Add-ons.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use \u003ccode\u003eaddChip()\u003c/code\u003e to add chips and \u003ccode\u003esetLayout()\u003c/code\u003e to configure the layout of the ChipList.\u003c/p\u003e\n"]]],[],null,["# Class ChipList\n\nChipList\n\nHolds a set of [Chip](/apps-script/reference/card-service/chip) objects that are displayed in a row, wrapping to the next line to\nhorizontal scrollable.\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 chip = CardService.newChip();\n// Finish building the text chip...\n\nconst chipList = CardService.newChipList()\n .setLayout(CardService.ChipListLayout.WRAPPED)\n .addChip(chip);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|---------------|----------------------------|\n| [addChip(chip)](#addChip(Chip)) | [ChipList](#) | Adds a chip. |\n| [setLayout(layout)](#setLayout(ChipListLayout)) | [ChipList](#) | Sets the chip list layout. |\n\nDetailed documentation\n----------------------\n\n### `add``Chip(chip)`\n\nAdds a chip.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|--------------------------------------------------|------------------|\n| `chip` | [Chip](/apps-script/reference/card-service/chip) | The chip to add. |\n\n#### Return\n\n\n[ChipList](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Layout(layout)`\n\nSets the chip list layout. If unset, it defaults to [ChipListLayout.WRAPPED](/apps-script/reference/card-service/chip-list-layout#WRAPPED) layout.\n\n```javascript\nconst chip = CardService.newChip();\n// Finish building the text chip...\n\nconst chipList =\n CardService.newChipList()\n .setLayout(CardService.ChipListLayout.HORIZONTAL_SCROLLABLE)\n .addChip(chip);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|------------------------------------------------------------------------|-----------------------|\n| `layout` | [ChipListLayout](/apps-script/reference/card-service/chip-list-layout) | The chip list layout. |\n\n#### Return\n\n\n[ChipList](#) --- This object, for chaining."]]
