This template showcases an app that embeds a canvas containing multiple cards that provide an overview of content in Microsoft Teams. Start with this template you can:

• Use widgets to display content from apps and services within your dashboard tab.
• Integrate your app with Graph API to visualize details about the implementation of the selected data.
• Create customizable dashboards that allow your business to set specific goals that help you track the information you need to view in multiple areas and across departments

Prerequisites To run the dashboard template in your local dev machine, you will need:

• Node.js, supported versions: 16, 18
• A Microsoft 365 account for development
• Set up your dev environment for extending Teams apps across Microsoft 365 Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.
• Teams Toolkit Visual Studio Code Extension version 5.0.0 and higher or Teams Toolkit CLI

1. First, select the Teams Toolkit icon on the left in the VS Code toolbar.
2. In the Account section, sign in with your Microsoft 365 account if you haven't already.
3. Press F5 to start debugging which launches your app in Teams using a web browser. Select Debug in Teams (Edge) or Debug in Teams (Chrome).
4. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.

Congratulations! You are running an application that can now show a dashboard in Teams:

The following files can be customized and demonstrate an example implementation to get you started.

The following are project-related files. You generally will not need to customize these files.

The following are Teams Toolkit specific project files. You can visit a complete guide on Github to understand how Teams Toolkit works.

Follow the steps below to add a new widget to the dashboard:

1. Step 1: Create a data retrive service
2. Step 2: Create a widget file
3. Step 3: Add the widget to the dashboard

Typically, a widget requires a service to retrieve the necessary data for displaying its content. This service can either fetch static data from a predefined source or retrieve dynamic data from a backend service or API.

For instance, we will implement a service that returns static data and place it under the src/services directory.

Here is a sample service for retrieving static data:

//sampleService.js
export const getSampleData = () => {
  return { content: "Hello world!" };
};

Create a widget file in the src/widgets folder. Inherit the BaseWidget class from @microsoft/teamsfx-react. The following table lists the methods that you can override to customize your widget.

All method overrides are optional.

Here's a sample widget implementation:

//SampleWidget.jsx
import { Button, Text } from "@fluentui/react-components";
import { BaseWidget } from "@microsoft/teamsfx-react";
import { getSampleData } from "../services/sampleService";

export class SampleWidget extends BaseWidget {
  async getData() {
    return getSampleData();
  }

  header() {
    return <Text>Sample Widget</Text>;
  }

  body() {
    return <div>{this.state.data?.content}</div>;
  }

  footer() {
    return <Button>View Details</Button>;
  }
}

Open the src/dashboards/SampleDashboard.jsx file and add the widget to the implementation of the layout method. If you want to create a new dashboard, please refer to How to add a new dashboard.

layout() {
  return (
    <>
      <ListWidget />
      <ChartWidget />
      <SampleWidget />
    </>
  );
}

Optional: If you want to arrange multiple widgets in the same column, you can refer to the following code snippet:

.one-column {
  display: grid;
  gap: 20px;
  grid-template-rows: 1fr 1fr;
}

layout() {
  return (
    <>
      <ListWidget />
      <div className="one-column">
        <ChartWidget />
        <SampleWidget />
      </div>
    </>
  );
}

Congratulations, you've just added your own widget! To learn more about the dashboard template, visit the documentation. You can find more scenarios like:

• Customize the widget
• Customize the dashboard layout
• Create a data loader
• Refresh data based on the schedule
• Handle empty state
• Add a new dashboard
• Use Microsoft Graph Toolkit as widget content
• Embed Power BI to dashboard
• How to add a new Graph API call
• Enable the app for multi-tenant
• Preview the app on mobile clients

• Fluent UI
• Fluent UI React Charting Example