List
A list component renders a collection of list items. Below you can see what's needed for both the List Component and List's Items
array.
{ type: "list", disabled: "true", items: [ { type: "item", id: "article-123", title: "How to install the messenger", subtitle: "An article explaining how to integrate Intercom", tertiary_text: "Read time: 4 mins", image: "http://somesite.com/article.png", image_width: 48, image_height: 48, roundedImage: false, disabled: true, action: { type: "submit" } } ]}
List
Parameter | Possible Values | Required | Function |
---|---|---|---|
items | Array (see below) | Yes | The items that will be rendered in the list. |
disabled | truefalse | No | The defined state of the inputted value to render a specific style. |
List Items
Parameter | Possible Values | Required | Function |
---|---|---|---|
id | Any string | Yes | Unique identifier for the component within this card. |
title | Any string | Yes | The text shown as the title for the list item. |
subtitle | Any string | No | The text shown underneath the list item's title. |
tertiary_text | Any string | No | The text shown next to the subtitle, separated by a bullet. |
image | A valid URL | No | An image that will be displayed on the left-hand side of the list |
image_width | Any number | Yes (if image provided) | Width of the image in pixels. |
image_height | Any number | Yes (if image provided) | Height of the image in pixels. |
rounded_image | truefalse (default) | No | Rounds the corners of the image if true. |
disabled | truefalse | No | The defined state of the inputted value to render a specific style. |
action | Action object | No | This can be a Submit Action, URL Action, or Sheets Action. |