Tabs on mobile

When you are building a Microsoft Teams app that includes a tab, you must test how your tab functions on both the Android and iOS Microsoft Teams clients. This article outlines some of the key scenarios you must consider.

If you choose to have your channel or group tab appear on Teams mobile clients, the setSettings() configuration must have a value for the websiteUrl property. To ensure optimal user experience, you must follow the guidance for tabs on mobile in this article when creating your tabs.

Apps distributed through the Teams store have a separate approval process for mobile clients. The default behavior of such apps is as follows:

App capability Behavior if app is approved Behavior if app is not approved
Personal tabs App appears in the bottom bar of the mobile clients. Tabs open in the Teams client. App does not appear in the bottom bar of the mobile clients.
Channel and group tabs The tab opens in the Teams client using contentUrl. The tab opens in a browser outside the Teams client using websiteUrl.

Note

  • Apps submitted to the AppSource for publishing on Teams are evaluated automatically for mobile responsiveness. For any queries, reach out to teamsubm@microsoft.com.
  • For all apps that are not distributed through the AppSource, the tabs open in an in-app webview within the Teams clients by default and there is no separate approval process required.
  • The default behavior of apps is only applicable if distributed through the Teams store. By default, all tabs open in the Teams client.
  • To initiate an evaluation of your app for mobile-friendliness, reach out to teamsubm@microsoft.com with your app details.
  • If a mobile app has multiple tabs, whenever the user switches a tab, the tab doesn't reload.

Authentication

For authentication to work on mobile clients, you must upgrade you Teams JavaScript library to at least version 1.4.1.

Low bandwidth and intermittent connections

Mobile clients function with low bandwidth and intermittent connections. Your app must handle any timeouts appropriately by providing a contextual message to the user. You must also use progress indicators to provide feedback to your users for any long-running processes.

Testing on mobile clients

You must validate that your tab functions properly on mobile devices of various sizes and qualities. For Android devices, you can use DevTools to debug your tab while it is running. It is recommended that you test on both high and low-performance devices, including a tablet.

Distribution

Apps listed on the Teams store must be approved for mobile use to function properly in the Teams mobile client. Tab availability and behavior depends on whether your app is approved.

Apps on Teams store approved for mobile

The following table describes tab availability and behavior when the app is listed on the Teams store and approved for mobile use:

Capability Mobile availability? Mobile behavior
Channel
and group tab
Yes Tab opens in the Teams mobile client using your app's contentUrl configuration.
Personal app Yes Each tab in the personal app tab opens in the Teams mobile client using its respective contentUrl configuration.

Apps on Teams store not approved for mobile

The following table describes tab availability and behavior when the app is listed on the Teams store but not approved for mobile use:

Capability Mobile availability? Mobile behavior
Channel and group tab Yes Tab opens in the device's default browser instead of the Teams mobile client using your app's websiteUrl configuration, which must also be included in your source code's setSettings() function. However, users can view the tab in the Teams mobile client by selecting More next to the app and choosing Open, which triggers your app’s contentUrl configuration.
Personal app No Not applicable

Note

  • The bot messages are shown in the chat section if a mobile app has both the bot and tab capabilities.
  • When you select Chat of the bot app and select More (...), you can't see the tab capability of that app in the list. However, if you select More (...) from the lower right of the Chat section, you can view the tab app with a link to the bot app capability of that app.

Apps not on Teams store

If you are sideloading your app or publishing to an organization's app catalog, tab behavior is the same as Teams store apps approved by Microsoft for mobile.

Next step

See also