@microsoft/teams.cards package
Classes
| ActionSet |
Displays a set of action, which can be placed anywhere in the card. |
| AdaptiveCard |
An Adaptive Card, containing a free-form body of card elements, and an optional set of actions. |
| AreaGridLayout |
A layout that divides a container into named areas into which elements can be placed. |
| AuthCardButton |
Defines a button as displayed when prompting a user to authenticate. For more information, refer to the Bot Framework CardAction type. |
| Authentication |
Defines authentication information associated with a card. For more information, refer to the Bot Framework OAuthCard type |
| BackgroundImage |
Defines a container's background image and the way it should be rendered. |
| Badge |
A badge element to show an icon and/or text in a compact form over a colored background. |
| BarChartDataValue |
A single data point in a bar chart. |
| CalendarEventAttendee |
Represents a calendar event attendee. |
| CalendarEventProperties |
The properties of a calendar event. |
| CaptionSource |
Defines a source URL for a video captions. |
| CardMetadata |
Card-level metadata. |
| Carousel |
A carousel with sliding pages. |
| CarouselPage |
A page inside a Carousel element. |
| Choice |
A choice as used by the Input.ChoiceSet input. |
| ChoiceSetInput |
An input to allow the user to select one or more values. |
| CodeBlock |
A formatted and syntax-colored code block. |
| CollabStageAction |
Adaptive Card action that opens a collab stage popout window. |
| CollabStageData |
Contains the Adaptive Card action data in CollabStageAction. |
| CollabStageValueData |
Contains the Adaptive Card action value data in <xref:CollabStageActionData>. |
| Column |
A column in a ColumnSet element. |
| ColumnDefinition |
Defines a column in a Table element. |
| ColumnSet |
Splits the available horizontal space into separate columns, so elements can be organized in a row. |
| ComEventMicrosoftGraphComponent |
Displays information about a calendar event. |
| ComFileMicrosoftGraphComponent |
Displays information about a file resource. |
| ComResourceMicrosoftGraphComponent |
Displays information about a generic graph resource. |
| ComUserMicrosoftGraphComponent |
Displays a user's information, including their profile picture. |
| ComUsersMicrosoftGraphComponent |
Displays multiple users' information, including their profile pictures. |
| CompoundButton |
A special type of button with an icon, title and description. |
| Container |
A container for other elements. Use containers for styling purposes and/or to logically group a set of elements together, which can be especially useful when used with Action.ToggleVisibility. |
| DateInput |
An input to allow the user to select a date. |
| DonutChart |
A donut chart. |
| DonutChartData |
A data point in a Donut chart. |
| ExecuteAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can respond synchronously and return an updated Adaptive Card to be displayed by the client. Action.Execute works in all Adaptive Card hosts. |
| Fact |
A fact in a FactSet element. |
| FactSet |
A set of facts, displayed as a table or a vertical list when horizontal space is constrained. |
| FileProperties |
Represents the properties of a file component. |
| FlowLayout |
A layout that spreads elements horizontally and wraps them across multiple rows, as needed. |
| GaugeChart |
A gauge chart. |
| GaugeChartLegend |
The legend of the chart. |
| GridArea |
Defines an area in a Layout.AreaGrid layout. |
| GroupedVerticalBarChart |
A grouped vertical bar chart. |
| GroupedVerticalBarChartData |
Represents a series of data points. |
| HorizontalBarChart |
A horizontal bar chart. |
| HorizontalBarChartDataValue |
Represents a single data point in a horizontal bar chart. |
| HostCapabilities |
Represents a list of versioned capabilities a host application must support. |
| IMBackAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| IMBackData | |
| Icon |
A standalone icon element. Icons can be picked from the vast Adaptive Card icon catalog. |
| IconInfo |
Defines information about a Fluent icon and how it should be rendered. |
| Image |
A standalone image element. |
| ImageSet |
A set of images, displayed side-by-side and wrapped across multiple rows as needed. |
| InvokeAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| InvokeData | |
| LineChart |
A line chart. |
| LineChartData |
Represents a collection of data points series in a line chart. |
| LineChartValue |
Represents a single data point in a line chart. |
| Media |
A media element, that makes it possible to embed videos inside a card. |
| MediaSource |
Defines the source URL of a media stream. YouTube, Dailymotion, Vimeo and Microsoft Stream URLs are supported. |
| Mention |
Represents a mention to a person. |
| MentionedEntity |
Represents a mentioned person or tag. |
| MessageBackAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| MessageBackData | |
| NumberInput |
An input to allow the user to enter a number. |
| OpenUrlAction |
Opens the provided URL in either a separate browser tab or within the host application. |
| PersonaProperties |
Represents the properties of a Persona component. |
| PersonaSetProperties |
Represents the properties of a PersonaSet component. |
| PieChart |
A pie chart. |
| QueryData |
Defines a query to dynamically fetch data from a Bot. |
| Rating |
A read-only star rating element, to display the rating of something. |
| RatingInput |
An input to allow the user to rate something using stars. |
| RefreshDefinition |
Defines how a card can be refreshed by making a request to the target Bot. |
| ResetInputsAction |
Resets the values of the inputs in the card. |
| ResourceProperties |
Represents the properties of a resource component. |
| ResourceVisualization |
Represents a visualization of a resource. |
| RichTextBlock |
A rich text block that displays formatted text. |
| ShowCardAction |
Expands or collapses an embedded card within the main card. |
| SignInAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| SignInData | |
| StackLayout |
A layout that stacks elements on top of each other. Layout.Stack is the default layout used by AdaptiveCard and all containers. |
| StackedHorizontalBarChart |
A stacked horizontal bar chart. |
| StackedHorizontalBarChartData |
Defines the collection of data series to display in as a stacked horizontal bar chart. |
| StackedHorizontalBarChartDataPoint |
A data point in a series. |
| SubmitAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| Table |
Use tables to display data in a tabular way, with rows, columns and cells. |
| TableCell |
Represents a cell in a table row. |
| TableRow |
Represents a row of cells in a table. |
| TargetElement |
Defines a target element in an Action.ToggleVisibility. |
| TaskFetchAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| TaskFetchData | |
| TeamsCardProperties |
Represents a set of Teams-specific properties on a card. |
| TeamsImageProperties |
Represents a set of Teams-specific properties on an image. |
| TeamsSubmitActionFeedback |
Represents feedback options for an Action.Submit. |
| TeamsSubmitActionProperties |
Teams-specific properties associated with the action. |
| TextBlock |
A block of text, optionally formatted using Markdown. |
| TextInput |
An input to allow the user to enter text. |
| TextRun |
A block of text inside a RichTextBlock element. |
| TimeInput |
An input to allow the user to select a time. |
| ToggleInput |
An input to allow the user to select between on/off states. |
| ToggleVisibilityAction |
Toggles the visibility of a set of elements. Action.ToggleVisibility is useful for creating "Show more" type UI patterns. |
| TokenExchangeResource |
Defines information required to enable on-behalf-of single sign-on user authentication. For more information, refer to the Bot Framework TokenExchangeResource type |
| VerticalBarChart |
A vertical bar chart. |
| VerticalBarChartDataValue |
Represents a data point in a vertical bar chart. |
Interfaces
| IActionSet |
Displays a set of action, which can be placed anywhere in the card. |
| IAdaptiveCard |
An Adaptive Card, containing a free-form body of card elements, and an optional set of actions. |
| IAreaGridLayout |
A layout that divides a container into named areas into which elements can be placed. |
| IAuthCardButton |
Defines a button as displayed when prompting a user to authenticate. For more information, refer to the Bot Framework CardAction type. |
| IAuthentication |
Defines authentication information associated with a card. For more information, refer to the Bot Framework OAuthCard type |
| IBackgroundImage |
Defines a container's background image and the way it should be rendered. |
| IBadge |
A badge element to show an icon and/or text in a compact form over a colored background. |
| IBarChartDataValue |
A single data point in a bar chart. |
| ICalendarEventAttendee |
Represents a calendar event attendee. |
| ICalendarEventProperties |
The properties of a calendar event. |
| ICaptionSource |
Defines a source URL for a video captions. |
| ICardMetadata |
Card-level metadata. |
| ICarousel |
A carousel with sliding pages. |
| ICarouselPage |
A page inside a Carousel element. |
| IChoice |
A choice as used by the Input.ChoiceSet input. |
| IChoiceSetInput |
An input to allow the user to select one or more values. |
| ICodeBlock |
A formatted and syntax-colored code block. |
| ICollabStageAction |
Adaptive Card action response type for the CollabStageAction function. |
| ICollabStageData |
Contains the Adaptive Card action data in CollabStageAction. |
| ICollabStageValueData |
Contains the Adaptive Card action value data in <xref:CollabStageActionData>. |
| IColumn |
A column in a ColumnSet element. |
| IColumnDefinition |
Defines a column in a Table element. |
| IColumnSet |
Splits the available horizontal space into separate columns, so elements can be organized in a row. |
| IComEventMicrosoftGraphComponent |
Displays information about a calendar event. |
| IComFileMicrosoftGraphComponent |
Displays information about a file resource. |
| IComResourceMicrosoftGraphComponent |
Displays information about a generic graph resource. |
| IComUserMicrosoftGraphComponent |
Displays a user's information, including their profile picture. |
| IComUsersMicrosoftGraphComponent |
Displays multiple users' information, including their profile pictures. |
| ICompoundButton |
A special type of button with an icon, title and description. |
| IContainer |
A container for other elements. Use containers for styling purposes and/or to logically group a set of elements together, which can be especially useful when used with Action.ToggleVisibility. |
| IDateInput |
An input to allow the user to select a date. |
| IDonutChart |
A donut chart. |
| IDonutChartData |
A data point in a Donut chart. |
| IExecuteAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can respond synchronously and return an updated Adaptive Card to be displayed by the client. Action.Execute works in all Adaptive Card hosts. |
| IFact |
A fact in a FactSet element. |
| IFactSet |
A set of facts, displayed as a table or a vertical list when horizontal space is constrained. |
| IFileProperties |
Represents the properties of a file component. |
| IFlowLayout |
A layout that spreads elements horizontally and wraps them across multiple rows, as needed. |
| IGaugeChart |
A gauge chart. |
| IGaugeChartLegend |
The legend of the chart. |
| IGridArea |
Defines an area in a Layout.AreaGrid layout. |
| IGroupedVerticalBarChart |
A grouped vertical bar chart. |
| IGroupedVerticalBarChartData |
Represents a series of data points. |
| IHorizontalBarChart |
A horizontal bar chart. |
| IHorizontalBarChartDataValue |
Represents a single data point in a horizontal bar chart. |
| IHostCapabilities |
Represents a list of versioned capabilities a host application must support. |
| IIMBackAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| IIMBackData | |
| IIcon |
A standalone icon element. Icons can be picked from the vast Adaptive Card icon catalog. |
| IIconInfo |
Defines information about a Fluent icon and how it should be rendered. |
| IImage |
A standalone image element. |
| IImageSet |
A set of images, displayed side-by-side and wrapped across multiple rows as needed. |
| IInvokeAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| IInvokeData | |
| ILineChart |
A line chart. |
| ILineChartData |
Represents a collection of data points series in a line chart. |
| ILineChartValue |
Represents a single data point in a line chart. |
| IMedia |
A media element, that makes it possible to embed videos inside a card. |
| IMediaSource |
Defines the source URL of a media stream. YouTube, Dailymotion, Vimeo and Microsoft Stream URLs are supported. |
| IMention |
Represents a mention to a person. |
| IMentionedEntity |
Represents a mentioned person or tag. |
| IMessageBackAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| IMessageBackData | |
| INumberInput |
An input to allow the user to enter a number. |
| IOpenUrlAction |
Opens the provided URL in either a separate browser tab or within the host application. |
| IPersonaProperties |
Represents the properties of a Persona component. |
| IPersonaSetProperties |
Represents the properties of a PersonaSet component. |
| IPieChart |
A pie chart. |
| IQueryData |
Defines a query to dynamically fetch data from a Bot. |
| IRating |
A read-only star rating element, to display the rating of something. |
| IRatingInput |
An input to allow the user to rate something using stars. |
| IRefreshDefinition |
Defines how a card can be refreshed by making a request to the target Bot. |
| IResetInputsAction |
Resets the values of the inputs in the card. |
| IResourceProperties |
Represents the properties of a resource component. |
| IResourceVisualization |
Represents a visualization of a resource. |
| IRichTextBlock |
A rich text block that displays formatted text. |
| IShowCardAction |
Expands or collapses an embedded card within the main card. |
| ISignInAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| ISignInData | |
| IStackLayout |
A layout that stacks elements on top of each other. Layout.Stack is the default layout used by AdaptiveCard and all containers. |
| IStackedHorizontalBarChart |
A stacked horizontal bar chart. |
| IStackedHorizontalBarChartData |
Defines the collection of data series to display in as a stacked horizontal bar chart. |
| IStackedHorizontalBarChartDataPoint |
A data point in a series. |
| ISubmitAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| ITabInfo |
Information about the content to embed in an iFrame. |
| ITable |
Use tables to display data in a tabular way, with rows, columns and cells. |
| ITableCell |
Represents a cell in a table row. |
| ITableRow |
Represents a row of cells in a table. |
| ITargetElement |
Defines a target element in an Action.ToggleVisibility. |
| ITaskFetchAction |
Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request. Action.Submit only works in Teams. |
| ITaskFetchData | |
| ITeamsCardProperties |
Represents a set of Teams-specific properties on a card. |
| ITeamsImageProperties |
Represents a set of Teams-specific properties on an image. |
| ITeamsSubmitActionFeedback |
Represents feedback options for an Action.Submit. |
| ITeamsSubmitActionProperties |
Teams-specific properties associated with the action. |
| ITextBlock |
A block of text, optionally formatted using Markdown. |
| ITextInput |
An input to allow the user to enter text. |
| ITextRun |
A block of text inside a RichTextBlock element. |
| ITimeInput |
An input to allow the user to select a time. |
| IToggleInput |
An input to allow the user to select between on/off states. |
| IToggleVisibilityAction |
Toggles the visibility of a set of elements. Action.ToggleVisibility is useful for creating "Show more" type UI patterns. |
| ITokenExchangeResource |
Defines information required to enable on-behalf-of single sign-on user authentication. For more information, refer to the Bot Framework TokenExchangeResource type |
| IVerticalBarChart |
A vertical bar chart. |
| IVerticalBarChartDataValue |
Represents a data point in a vertical bar chart. |