Tag element
This is a rich text element, compatible only with the rich_text block. It must be used within the rich_text_list, rich_text_quote, or rich_text_section block element within the rich_text block's elements array.
Fields
| Field | Type | Description | Required? |
|---|---|---|---|
type | String | The type of object; in this case, "tag". | Required |
text | String | The text displayed in the tag. | Required |
color | String | The color of the tag. The options for this value are: "gray", "brown", "purple", "indigo", "blue", "green", "yellow", "orange", "red". | Optional |
style | Object | An object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, underline, and unlink. | Optional |
Example
- JSON
{
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "tag",
"text": "In progress"
}
]
}
]
}
]
}