Schema Explorer

Choose element:

Important note about accessibility: In version 1.3 of the schema we introduced a label property on Inputs to improve accessibility. If the Host app you are targeting supports v1.3 you should use label instead of a TextBlock as seen in some samples below. Once most Host apps have updated to the latest version we will update the samples accordingly.

RichTextBlock

Defines an array of inlines, allowing for inline text formatting.

Introduced in version 1.2

Property Type Required Description Version
type "RichTextBlock" Yes Must be "RichTextBlock". 1.2
inlines Inline[] Yes The array of inlines. 1.2
horizontalAlignment HorizontalAlignment? No Controls the horizontal text alignment. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left. 1.2

Inherited properties

Property Type Required Description Version
fallback Element, FallbackOption No Describes what to do when an unknown element is encountered or the requires of this or any children can’t be met. 1.2
height BlockElementHeight No Specifies the height of the element. 1.1
separator boolean No When true, draw a separating line at the top of the element. 1.2
spacing Spacing No Controls the amount of spacing between this element and the preceding element. 1.2
id string No A unique identifier associated with the item. 1.2
isVisible boolean No, default: true If false, this item will be removed from the visual tree. 1.2
requires Dictionary<string> No A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered. 1.2

Example

JSON 
{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.2",
	"body": [
		{
			"type": "RichTextBlock",
			"inlines": [
				"This is the first inline. ",
				{
					"type": "TextRun",
					"text": "We support colors,",
					"color": "good"
				},
				{
					"type": "TextRun",
					"text": " both regular and subtle. ",
					"isSubtle": true
				},
				{
					"type": "TextRun",
					"text": "Text ",
					"size": "small"
				},
				{
					"type": "TextRun",
					"text": "of ",
					"size": "medium"
				},
				{
					"type": "TextRun",
					"text": "all ",
					"size": "large"
				},
				{
					"type": "TextRun",
					"text": "sizes! ",
					"size": "extraLarge"
				},
				{
					"type": "TextRun",
					"text": "Light weight text. ",
					"weight": "lighter"
				},
				{
					"type": "TextRun",
					"text": "Bold weight text. ",
					"weight": "bolder"
				},
				{
					"type": "TextRun",
					"text": "Highlights. ",
					"highlight": true
				},
				{
					"type": "TextRun",
					"text": "Italics. ",
					"italic": true
				},
				{
					"type": "TextRun",
					"text": "Strikethrough. ",
					"strikethrough": true
				},
				{
					"type": "TextRun",
					"text": "Monospace too!",
					"fontType": "monospace"
				}
			]
		},
		{
			"type": "RichTextBlock",
			"inlines": [
				{
					"type": "TextRun",
					"text": "Date-Time parsing: {{DATE(2017-02-14T06:08:39Z,LONG)}} {{TIME(2017-02-14T06:08:39Z)}}"
				}
			]
		},
		{
			"type": "RichTextBlock",
			"horizontalAlignment": "center",
			"inlines": [
				{
					"type": "TextRun",
					"text": "Rich text blocks also support center alignment. Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor "
				}
			]
		},
		{
			"type": "RichTextBlock",
			"horizontalAlignment": "right",
			"inlines": [
				{
					"type": "TextRun",
					"text": "Rich text blocks also support right alignment. Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor Lorem ipsum dolor "
				}
			]
		},
		{
			"type": "RichTextBlock",
			"inlines": []
		}
	]
}
Adaptive Card

Properties

inlines

The array of inlines.

  • Type: Inline[]
  • Required: Yes
  • Allowed values:
    • TextRun
    • string

horizontalAlignment

Controls the horizontal text alignment. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.

  • Type: HorizontalAlignment?
  • Required: No
  • Allowed values:
    • "left"
    • "center"
    • "right"

fallback

Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.

  • Type: Element, FallbackOption
  • Required: No
  • Allowed values:
    • ActionSet
    • ColumnSet
    • Container
    • FactSet
    • Image
    • ImageSet
    • Input.ChoiceSet
    • Input.Date
    • Input.Number
    • Input.Text
    • Input.Time
    • Input.Toggle
    • Media
    • RichTextBlock
    • Table
    • TextBlock
    • "drop": Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.

height

Specifies the height of the element.

  • Type: BlockElementHeight
  • Version : 1.1
  • Required: No
  • Allowed values:
    • "auto": The height of the container will be determined by the height of its contents.
    • "stretch": The container will stretch its height to the available remaining height of the parent container.

separator

When true, draw a separating line at the top of the element.

  • Type: boolean
  • Required: No

spacing

Controls the amount of spacing between this element and the preceding element.

  • Type: Spacing
  • Required: No
  • Allowed values:
    • "default"
    • "none"
    • "small"
    • "medium"
    • "large"
    • "extraLarge"
    • "padding"

id

A unique identifier associated with the item.

  • Type: string
  • Required: No

isVisible

If false, this item will be removed from the visual tree.

  • Type: boolean
  • Required: No, default: true

requires

A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.

  • Type: Dictionary<string>
  • Required: No