ICompoundButton interface

Package:

@microsoft/teams.cards

A special type of button with an icon, title and description.

Properties

badge	The badge to show on the button.
description	The description text of the button.
fallback	An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.
grid.area	The area of a Layout.AreaGrid layout in which an element should be displayed.
height	The height of the element. When set to stretch, the element will use the remaining vertical space in its container.
horizontalAlignment	Controls how the element should be horizontally aligned.
icon	The icon to show on the button.
id	A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.
isSortKey	Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements.
isVisible	Controls the visibility of the element.
lang	The locale associated with the element.
requires	A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).
selectAction	An Action that will be invoked when the button is tapped or clicked. Action.ShowCard is not supported.
separator	Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true.
spacing	Controls the amount of space between this element and the previous one. No space will be added for the first element in a container.
targetWidth	Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout.
title	The title of the button.
type	Must be CompoundButton.

Property Details

badge

The badge to show on the button.

badge?: string

Property Value

string

description

The description text of the button.

description?: string

Property Value

string

fallback

An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.

fallback?: FallbackElement

Property Value

FallbackElement

grid.area

The area of a Layout.AreaGrid layout in which an element should be displayed.

grid.area?: string

Property Value

string

height

The height of the element. When set to stretch, the element will use the remaining vertical space in its container.

height?: ElementHeight

Property Value

ElementHeight

horizontalAlignment

Controls how the element should be horizontally aligned.

horizontalAlignment?: HorizontalAlignment

Property Value

HorizontalAlignment

icon

The icon to show on the button.

icon?: IIconInfo

Property Value

IIconInfo

id

A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.

id?: string

Property Value

string

isSortKey

Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements.

isSortKey?: boolean

Property Value

boolean

isVisible

Controls the visibility of the element.

isVisible?: boolean

Property Value

boolean

lang

The locale associated with the element.

lang?: string

Property Value

string

requires

A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).

requires?: IHostCapabilities

Property Value

IHostCapabilities

selectAction

An Action that will be invoked when the button is tapped or clicked. Action.ShowCard is not supported.

selectAction?: IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityAction

Property Value

IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityAction

separator

Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true.

separator?: boolean

Property Value

boolean

spacing

Controls the amount of space between this element and the previous one. No space will be added for the first element in a container.

spacing?: Spacing

Property Value

Spacing

targetWidth

Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout.

targetWidth?: TargetWidth

Property Value

TargetWidth

title

The title of the button.

title?: string

Property Value

string

type

Must be CompoundButton.

type: "CompoundButton"

Property Value

"CompoundButton"