ts

page_type	products	languages	description	extensions	urlFragment
sample	office office-teams office-365	typescript javascript html	This sample app provides tested, high-quality UI templates to help developers understand how to create effective applications for Microsoft Teams, covering common use cases like dashboards and forms.	contentType createdDate samples 12/08/2020 05:06:47 PM	officedev-microsoft-teams-samples-tab-ui-templates-ts

Deploying the Microsoft Teams UI templates sample app

This sample app illustrates best practices for designing applications within Microsoft Teams, featuring a collection of high-quality UI templates that have been rigorously tested for various common use cases, including dashboards and forms. By leveraging these templates, developers can create visually appealing and user-friendly applications that enhance the overall Teams experience.

Included Features

• Tabs
• UI Templates

Interaction with tab

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).

Teams UI templates: Manifest

Prerequisites

• Install Git
• Node.js and npm. Run the command node --version to verify that Node.js is installed.
• Set up a Microsoft 365 developer account, which allows app sideloading in Teams.
• Teams Toolkit for VS Code or TeamsFx CLI

Set up your app project

Open a terminal and clone the sample app repository.

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
cd Microsoft-Teams-Samples/samples/tab-ui-templates/ts
yarn install

You can find the app source code in ./src:

• app: Includes the app scaffolding.

• appManifest: Includes the app manifest (manifest.json) and the color and outline versions of the app icon.

• assets: Includes the app assets.

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.

1. Ensure you have downloaded and installed Visual Studio Code
2. Install the Teams Toolkit extension
3. Select File > Open Folder in VS Code and choose this samples directory from the repo
4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
6. 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.

Run the app (Manually Uploading to Teams)

1. In the root directory of your project, run the following command.

   yarn start

   When the app starts, you should see the following terminal output.

     You can now view microsoft-teams-app-sample in the browser.
       Local:            http://localhost:3978
       On Your Network:  http://192.168.0.10:3978
   

2. Open a browser and verify that all of the following URLs load:

   • Required Teams app pages:
     • About: http://localhost:3978
     • Privacy: http://localhost:3978/#/privacy
     • Terms of use: http://localhost:3978/#/termsofuse
   • Sample app tabs:
     • http://localhost:3978/#/welcome
     • http://localhost:3978/#/dashboard
     • http://localhost:3978/#/list
     • http://localhost:3978/#/board

Set up a secure tunnel to the app

Teams doesn't display app content unless it's accessible via HTTPS. We recommend using ngrok to establish a secure tunnel to where you're hosting the app locally (for example, http://localhost:3978).

1. Install dev tunnel or ngrok latest version or equivalent tunneling solution

2. 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

3. Save the HTTPS URL in the output (for example, https://468b9ab725e9.ngrok-free.app). You may need this later if you plan to register the app with App Studio.

Important

If you're using the free version of ngrok and plan to share the app with others, remember that ngrok quits if your machine shuts down or goes to sleep. When you restart ngrok, the URL also will be different. (A paid version of ngrok provides persistent URLs.)

Create the app package

1. This step is specific to Teams.
   • Edit the manifest.json contained in the src/appManifest folder to replace <<GUID_ID>> with any GUID value.
   • Edit the manifest.json for staticTabs inside the contentUrl replace <<HOSTNAME>> with base Url 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. Replace the same value for <<HOSTNAME>> inside validDomains section.
   • Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the tab-ui-templates\ts\src\appManifest_Hub folder with the required values.
   • Zip up the contents of the Manifest folder to create a Manifest.zip or appManifest_Hub folder to create a appManifest_Hub.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
   • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
   • Add the app to personal scope.

Sideload the app in Teams

1. In the Teams client, go to Apps.

2. Select Upload a custom app and upload the app package, which is the generated zip file in the package folder.

   

Running the sample

• Welcome Page

• Dashboard Page

• List Page

• Board Page

Outlook on the web

• To view your app in Outlook on the web.

• Go to Outlook on the weband sign in using your dev tenant account.

On the side bar, select More Apps. Your sideloaded app title appears among your installed apps

Select your app icon to launch and preview your app running in Outlook on the web

Note: Similarly, you can test your application in the Outlook desktop app as well.

Office on the web

• To preview your app running in Office on the web.

• Log into office.com with test tenant credentials

Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps

Select your app icon to launch your app in Office on the web

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Next steps

• Design your Teams app with UI templates.
• Implement UI templates with the Microsoft Teams UI Library.

Further reading

• Tabs
• Extend Teams apps across Microsoft 365