Schema Explorer

Input.Text

Lets a user enter text.

Property Type Required Description Version
id string Yes Unique identifier for the value. Used to identify collected input when the Submit action is performed. 1.0
isMultiline boolean No, default: false If true, allow multiple lines of input. 1.0
maxLength number No Hint of maximum length characters to collect (may be ignored by some clients). 1.0
placeholder string No Description of the input desired. Displayed when no text has been input. 1.0
style string No, default: "text" Style hint for Input.Text. 1.0
type "Input.Text" Yes Must be "Input.Text". 1.0
value string No The initial value for this field. 1.0
spacing string No Controls the amount of spacing between this element and the preceding element. 1.0
separator boolean No, default: false When true, draw a separating line at the top of the element. 1.0

Example

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "TextBlock",
			"text": "Default text input"
		},
		{
			"type": "Input.Text",
			"id": "input1",
			"placeholder": "enter comment",
			"maxLength": 500
		},
		{
			"type": "TextBlock",
			"text": "Multiline text input"
		},
		{
			"type": "Input.Text",
			"id": "input2",
			"placeholder": "enter comment",
			"maxLength": 500,
			"isMultiline": true
		},
		{
			"type": "TextBlock",
			"text": "Pre-filled value"
		},
		{
			"type": "Input.Text",
			"id": "input3",
			"placeholder": "enter comment",
			"maxLength": 500,
			"isMultiline": true,
			"value": "This value was pre-filled"
		}
	],
	"actions": [
		{
			"type": "Action.Submit",
			"title": "OK"
		}
	]
}
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "Default text input" }, { "type": "Input.Text", "id": "input1", "placeholder": "enter comment", "maxLength": 500 }, { "type": "TextBlock", "text": "Multiline text input" }, { "type": "Input.Text", "id": "input2", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true }, { "type": "TextBlock", "text": "Pre-filled value" }, { "type": "Input.Text", "id": "input3", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true, "value": "This value was pre-filled" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] }
Try it Yourself »

Properties

id

Unique identifier for the value. Used to identify collected input when the Submit action is performed.

  • Type: string
  • Required: Yes

isMultiline

If true, allow multiple lines of input.

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

maxLength

Hint of maximum length characters to collect (may be ignored by some clients).

  • Type: number
  • Required: No

placeholder

Description of the input desired. Displayed when no text has been input.

  • Type: string
  • Required: No

style

Style hint for Input.Text.

  • Type: string
  • Required: No, default: "text"
  • Allowed values:
    • "text"
    • "tel"
    • "url"
    • "email"

Example

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "TextBlock",
			"text": "Specify the type of text being requested"
		},
		{
			"type": "Input.Text",
			"id": "myComment",
			"placeholder": "text",
			"style": "text"
		},
		{
			"type": "TextBlock",
			"text": "style: email"
		},
		{
			"type": "Input.Text",
			"id": "myEmail",
			"placeholder": "email",
			"style": "email"
		},
		{
			"type": "TextBlock",
			"text": "style: tel"
		},
		{
			"type": "Input.Text",
			"id": "myTel",
			"placeholder": "tel",
			"style": "tel"
		},
		{
			"type": "TextBlock",
			"text": "style: url"
		},
		{
			"type": "Input.Text",
			"id": "myUrl",
			"placeholder": "url",
			"style": "url"
		}
	],
	"actions": [
		{
			"type": "Action.Submit",
			"title": "OK"
		}
	]
}
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "Specify the type of text being requested" }, { "type": "Input.Text", "id": "myComment", "placeholder": "text", "style": "text" }, { "type": "TextBlock", "text": "style: email" }, { "type": "Input.Text", "id": "myEmail", "placeholder": "email", "style": "email" }, { "type": "TextBlock", "text": "style: tel" }, { "type": "Input.Text", "id": "myTel", "placeholder": "tel", "style": "tel" }, { "type": "TextBlock", "text": "style: url" }, { "type": "Input.Text", "id": "myUrl", "placeholder": "url", "style": "url" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] }
Try it Yourself »

type

Must be "Input.Text".

  • Type: "Input.Text"
  • Required: Yes
  • Allowed values:
    • Input.Text

value

The initial value for this field.

  • Type: string
  • Required: No

spacing

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

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

separator

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

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