Some cells â such as dropdowns, radio buttons, switches, chips, or multi-select components â support multiple selectable options. These are defined using the
option
field, which is an array of Option
objects.Each
Option
represents a selectable item that can appear within the cell UI, enabling users to choose one or more values depending on the cell's form (e.g., radio
, dropdown
, multi-choice
, chip
, etc.).ButtonOption Object
Field | Type | Required | Description |
id | String | Yes | Unique identifier for the option (used for internal tracking or callbacks). |
label | String | Conditionally | Main display text of the option shown to the user. If supported by the cell form. |
sublabel | String | Conditionally | Optional secondary text displayed below the label. If supported by the cell form. |
icon | String | Conditionally | Icon to be shown before the label. If supported by the cell form. |
trailing_icon | String | Conditionally | Icon displayed at the trailing (end) side of the option. If supported by the cell form. |
trailing_text | String | Conditionally | Text displayed at the trailing end of the option (e.g., a price or status). If supported by the cell form. |
divider | Boolean | Conditionally | Whether a visual divider appears below this option. If supported by the cell form. |
image | String | Conditionally | Image URL to be displayed with the option (useful for visual selections). If supported by the cell form. |
value | String | Yes | The value is submitted when this option is selected. Used for API callbacks or form submission. If supported by the cell form. |
Example
json"option": [ { "id": "size_l", "label": "Large", "value": "L", }, { "id": "size_m", "label": "Medium", "value": "M" }, { "id": "size_s", "label": "Small", "value": "S", } ]