Schema Explorer

Input.Toggle

Lets a user choose between two options.

Property Type Required Description Version
type "Input.Toggle" Yes Must be "Input.Toggle". 1.0
title string Yes Title for the toggle 1.0
id string Yes Unique identifier for the value. Used to identify collected input when the Submit action is performed. 1.0
value string No, default: "false" The current selected value. If the item is selected that “valueOn” will be used, otherwise “valueOff” 1.0
valueOff string No, default: "false" The value when toggle is off 1.0
valueOn string No, default: "true" The value when toggle is on 1.0
wrap boolean No If true, allow text to wrap. Otherwise, text is clipped. 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.0
spacing Spacing No Controls the amount of spacing between this element and the preceding element. 1.0
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

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "TextBlock",
			"text": "Toggle Input"
		},
		{
			"type": "Input.Toggle",
			"id": "acceptTerms",
			"title": "I accept the terms and agreements",
			"value": "true",
			"valueOn": "true",
			"valueOff": "false"
		}
	],
	"actions": [
		{
			"type": "Action.Submit",
			"title": "OK"
		}
	]
}
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "Toggle Input" }, { "type": "Input.Toggle", "id": "acceptTerms", "title": "I accept the terms and agreements", "value": "true", "valueOn": "true", "valueOff": "false" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] }
Try it Yourself »

Properties

title

Title for the toggle

  • Type: string
  • Required: Yes

value

The current selected value. If the item is selected that "valueOn" will be used, otherwise "valueOff"

  • Type: string
  • Required: No, default: "false"

valueOff

The value when toggle is off

  • Type: string
  • Required: No, default: "false"

valueOn

The value when toggle is on

  • Type: string
  • Required: No, default: "true"

wrap

If true, allow text to wrap. Otherwise, text is clipped.

  • Type: boolean
  • Version : 1.2
  • Required: No

id

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

  • Type: string
  • Required: Yes

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
  • Version : 1.2
  • 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
    • "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"

isVisible

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

  • Type: boolean
  • Version : 1.2
  • 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>
  • Version : 1.2
  • Required: No