Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc Improvement][Adaptive Card website banner][4314613] #12473

Merged
merged 19 commits into from
Apr 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions msteams-platform/includes/adaptive-card-redirect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/).
>
> :::image type="content" source="../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ ms.date: 11/07/2024

# Card actions

[!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)]

Cards used by bots and message extensions in Microsoft Teams support the following activity [`CardAction`](/bot-framework/dotnet/bot-builder-dotnet-add-rich-card-attachments#process-events-within-rich-cards) types:

> [!NOTE]
Expand Down Expand Up @@ -417,6 +419,9 @@ CardFactory.actions([

## Adaptive Cards actions

> [!IMPORTANT]
> This documentation is considered legacy. For comprehensive information and resources related to Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/).

Adaptive Cards support the following six action types:

* [Action.OpenUrl](https://adaptivecards.microsoft.com/?topic=Action.OpenUrl): Opens the specified url.
Expand Down
8 changes: 8 additions & 0 deletions msteams-platform/task-modules-and-cards/cards/cards-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ You can use newlines for Adaptive Cards using `\r` or `\n` escape sequences for

Formatting is different between the desktop and the mobile versions of Teams for Adaptive Cards and connector cards. In this section, you can go through the Markdown format example for Adaptive Cards and connector cards.

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to text formatting in Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=TextBlock).
>
> :::image type="content" source="../../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

# [Markdown format for Adaptive Cards](#tab/adaptive-md)

The following table provides the supported styles for `Textblock`, `Fact.Title`, and `Fact.Value`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ After identifying the common properties for all cards, you can now work with Ada

## Adaptive Card

[!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)]

An Adaptive Card is a customizable card that can contain any combination of text, speech, images, buttons, and input fields. For more information, see [Adaptive Cards](https://github.com/microsoft/AdaptiveCards/releases/tag/2020.07).

To explore Adaptive Card templates, see [Adaptive Card starter collection](design-effective-cards.md#adaptive-card-starter-collection).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ ms.date: 11/07/2024

# Charts in Adaptive Cards

You can visually represent data through charts in Adaptive Cards. You can use charts for performance dashboards, budget allocations, project management, customer insights, and more.
[!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)]

You can visually represent data through charts in Adaptive Cards. You can use charts for performance dashboards, budget allocations, project management, customer insights, and more. Teams supports the following types of charts:

* [Donut chart](https://adaptivecards.microsoft.com/?topic=Chart.Donut)
* [Gauge chart](https://adaptivecards.microsoft.com/?topic=Chart.Gauge)
* [Grouped vertical bar chart](https://adaptivecards.microsoft.com/?topic=Chart.VerticalBar.Grouped)
* [Horizontal bar chart](https://adaptivecards.microsoft.com/?topic=Chart.HorizontalBar)
* [Line chart](https://adaptivecards.microsoft.com/?topic=Chart.Line)
* [Pie chart](https://adaptivecards.microsoft.com/?topic=Chart.Pie)
* [Stacked horizontal bar chart](https://adaptivecards.microsoft.com/?topic=Chart.HorizontalBar.Stacked)
* [Vertical bar chart](https://adaptivecards.microsoft.com/?topic=Chart.VerticalBar)

## Donut chart

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ ms.date: 11/07/2024
---
# Designing Adaptive Cards for your Microsoft Teams app

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to Adaptive Card design best practices, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=design-best-practices).
>
> :::image type="content" source="../../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

An Adaptive Card contains a freeform body of card elements and optional set of actions. Adaptive Cards are actionable snippets of content that you can add to a conversation through a bot or message extension. Using text, graphics, and buttons, these cards provide rich communication to your audience.

The Adaptive Card framework is used across many Microsoft products, including Teams. You can send cards inside messages to users via bots or message extensions. Users can also take actions on cards when present.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ ms.date: 01/23/2025

# Typeahead search in Adaptive Cards

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to typahead search in Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=dynamic-typeahead).
>
> :::image type="content" source="../../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

Typeahead search functionality in Adaptive Cards gives an enhanced search experience on `Input.ChoiceSet` component. It provides a list of choices to enter text in the search field. You can incorporate typeahead search with Adaptive Cards to search and select data.

You can use typeahead search for the following searches:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ ms.date: 02/26/2025

# Media elements in Adaptive Card

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to media in Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=Media).
>
> :::image type="content" source="../../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

Adaptive Card media element is a component that is used to embed audio and video files directly into your Adaptive Card. Media elements enhance the user experience by making the cards more interactive and engaging. Your app users can view and play media files directly within Adaptive Cards in Teams. Here are few benefits about media elements in Adaptive Card:

* ***Enhanced engagement***: Adding media elements makes the cards more effective and can capture app users attention more effectively.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ ms.date: 02/26/2025

# People Picker in Adaptive Cards

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to People Picker in Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=people-picker).
>
> :::image type="content" source="../../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

People Picker helps users to search and select users in Adaptive Card. You can add People Picker as input control to Adaptive Card, which works across chats, channels, dialogs (referred as task modules in TeamsJS v1.x), and tabs. People Picker supports the following features:

* Searches single or multiple users.
Expand Down
8 changes: 8 additions & 0 deletions msteams-platform/task-modules-and-cards/container-layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ ms.date: 11/07/2024

# Container layouts

> [!IMPORTANT]
>
> This documentation is considered legacy. For comprehensive information and resources related to container layouts in Adaptive Cards, visit the [Adaptive Cards documentation hub](https://adaptivecards.microsoft.com/?topic=container-layouts).
>
> :::image type="content" source="../assets/images/adaptive-cards/new-adaptive-card-hub.png" alt-text="Screenshot shows the home page of the Microsoft Adaptive Cards website.":::
>
> The Adaptive Cards documentation hub offers complete and latest reference documentation, an updated Adaptive Card Designer, built-in JSON examples, design best practices, and a detailed release history of Adaptive Card features. For more information, see [introducing the Adaptive Cards documentation hub and new Adaptive Cards updates](https://devblogs.microsoft.com/microsoft365dev/introducing-the-adaptive-cards-documentation-hub-and-new-adaptive-cards-updates/#:~:text=Explore%20the%20latest%20adaptive%20card%20features%20and%20samples,productivity%E2%80%94all%20seamlessly%20integrated%20into%20your%20users%E2%80%99%20daily%20workflows.).

Containers such as `Container`, `Column`, `TableCell`, or an Adaptive Card itself support three different types of layouts:

* [Layout.Stack](#layoutstack) stacks elements on top of each other and is the default layout.
Expand Down
2 changes: 2 additions & 0 deletions msteams-platform/task-modules-and-cards/what-are-cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ All cards used by Teams are listed in [types of cards](~/task-modules-and-cards/

## Adaptive Cards

[!INCLUDE [adaptive-card-redirect](../includes/adaptive-card-redirect.md)]

[Adaptive Cards](~/task-modules-and-cards/cards/cards-reference.md#adaptive-card) are a new cross product specification for cards in Microsoft products including bots, Cortana, Outlook, and Windows. They're the recommended card type for new Teams development. For general information from the Adaptive Cards team, see [Adaptive Cards overview](/adaptive-cards). You can use Adaptive Cards anywhere you use existing hero cards, Microsoft 365 cards, and thumbnail cards.

In addition to Adaptive Cards, Teams supports two other types of cards:
Expand Down