Tabs quick start

Code Sample
06/04/2024

Tabs are Teams-aware webpages embedded in Microsoft Teams. A channel/group tab delivers content to channels and group chats, and are a great way to create collaborative spaces around dedicated web-based content.

Included Features

Tabs

Interaction with app.

tabconfigure

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Tab Channel quick start: Manifest

Prerequisites

Microsoft Teams is installed and you have an account (not a guest account)
To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher)
dev tunnel or ngrok latest version or equivalent tunneling solution
M365 developer account or access to a Teams account with the
Teams Toolkit for VS Code or TeamsFx CLI

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

Ensure you have downloaded and installed Visual Studio Code
Install the Teams Toolkit extension
Select File > Open Folder in VS Code and choose this samples directory from the repo
Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
Select Debug > Start Debugging or F5 to run the app in a Teams web client.
In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Setup

Register a new application in the Microsoft Entra ID – App Registrations portal. NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.
Setup NGROK

Run ngrok - point to port 3978
```
ngrok http 3978 --host-header="localhost:3978"
```
Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:
```
devtunnel host -p 3978 --allow-anonymous
```

Setup for code

Clone the repository

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

In a terminal, navigate to samples/tab-channel-group-quickstart/ts
Install modules
```
npm install
```
Run your app
```
npm start
```

Setup Manifest for Teams

This step is specific to Teams.
- Edit the manifest.json contained in the appManifest/ folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId) everywhere you see the place holder string {MicrosoftAppId} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
- Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
- Zip up the contents of the appManifest/ folder to create a manifest.zip
- Upload the manifest.zip to Teams (in the left-bottom Apps view, click "Upload a custom app")```

Deploy to Teams

Start debugging the project by hitting the F5 key or click the debug icon in Visual Studio Code and click the Start Debugging green arrow button.

NOTE: First time debug step

On the first time running and debugging your app you need allow the localhost certificate. After starting debugging when Chrome is launched and you have installed your app it will fail to load.

Open a new tab in the same browser window that was opened
Navigate to https://localhost:3000/tab
Click the Advanced button
Select the Continue to localhost

NOTE: Debugging

Ensure you have the Debugger for Chrome/Edge extension installed for Visual Studio Code from the marketplace.

Build for production

npm run build

Running the sample.

tabconfigure

setuptab

Helloworld

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Share via