Schema Explorer
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 targetting supports v1.3 you should use label intead 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.
AdaptiveCard
An Adaptive Card, containing a free-form body of card elements, and an optional set of actions.
Property | Type | Required | Description | Version |
---|---|---|---|---|
type | "AdaptiveCard" |
Yes | Must be "AdaptiveCard" . |
|
version | string |
Yes | Schema version that this card requires. If a client is lower than this version, the fallbackText will be rendered. NOTE: Version is not required for cards within an Action.ShowCard . However, it is required for the top-level card. |
1.0 |
body | Element[] |
No | The card elements to show in the primary card region. | 1.0 |
actions | Action[] |
No | The Actions to show in the card’s action bar. | 1.0 |
selectAction | ISelectAction |
No | An Action that will be invoked when the card is tapped or selected. Action.ShowCard is not supported. |
1.1 |
fallbackText | string |
No | Text shown when the client doesn’t support the version specified (may contain markdown). | 1.0 |
backgroundImage | BackgroundImage , uri |
No | Specifies the background image of the card. | 1.2, 1.0 |
minHeight | string |
No | Specifies the minimum height of the card. | 1.2 |
speak | string |
No | Specifies what should be spoken for this entire card. This is simple text or SSML fragment. | 1.0 |
lang | string |
No | The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions. | 1.0 |
verticalContentAlignment | VerticalContentAlignment |
No | Defines how the content should be aligned vertically within the container. Only relevant for fixed-height cards, or cards with a minHeight specified. |
1.1 |
$schema | uri |
No | The Adaptive Card schema. | 1.0 |
Example
Properties
version
Schema version that this card requires. If a client is lower than this version, the fallbackText
will be rendered. NOTE: Version is not required for cards within an Action.ShowCard
. However, it is required for the top-level card.
- Type:
string
- Required: No
body
The card elements to show in the primary card region.
- Type:
Element[]
- Required: No
- Allowed values:
ActionSet
ColumnSet
Container
FactSet
Image
ImageSet
Input.ChoiceSet
Input.Date
Input.Number
Input.Text
Input.Time
Input.Toggle
Media
RichTextBlock
TextBlock
actions
The Actions to show in the card's action bar.
- Type:
Action[]
- Required: No
- Allowed values:
Action.OpenUrl
Action.ShowCard
Action.Submit
Action.ToggleVisibility
selectAction
An Action that will be invoked when the card is tapped or selected. Action.ShowCard
is not supported.
- Type:
ISelectAction
- Version : 1.1
- Required: No
- Allowed values:
Action.OpenUrl
Action.Submit
Action.ToggleVisibility
fallbackText
Text shown when the client doesn't support the version specified (may contain markdown).
- Type:
string
- Required: No
backgroundImage
Specifies the background image of the card.
- Type:
BackgroundImage
,uri
- Version : 1.2, 1.0
- Required: No
- Allowed values:
BackgroundImage
uri
minHeight
Specifies the minimum height of the card.
- Type:
string
- Version : 1.2
- Required: No
speak
Specifies what should be spoken for this entire card. This is simple text or SSML fragment.
- Type:
string
- Required: No
lang
The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions.
- Type:
string
- Required: No
verticalContentAlignment
Defines how the content should be aligned vertically within the container. Only relevant for fixed-height cards, or cards with a minHeight
specified.
- Type:
VerticalContentAlignment
- Version : 1.1
- Required: No
- Allowed values:
"top"
"center"
"bottom"
$schema
The Adaptive Card schema.
- Type:
uri
- Required: No