ts

page_type	description	products	languages	extensions	urlFragment
sample	Sample to show navbar-menu in personal tab app.	office-teams office office-365	typescript nodejs	contentType createdDate samples 29/12/2022 01:38:27 PM	officedev-microsoft-teams-samples-tab-navbar-menu-ts

Teams Personal Tab Navbar-Menu Sample TS

Add multiple actions to the upper right NavBar and build an overflow menu for extra actions in an app.

Note: NaveBar menu is only supported in Mobile Clients.

Included Features

• Tabs
• NavBar Menu

Interaction with app - Mobile

Prerequisites

• Microsoft Teams is installed and you have an account (not a guest account)
• NodeJS
• dev tunnel or ngrok latest version or equivalent tunneling solution
• 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.

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.

Mobile app test:

If you test this sample via toolkit, once the toolkit runs successfully, go to appManifest -> build -> appManifest.local, unzip it, and change 'https://localhost:3978' to your ngrok URL.

Setup

1. Setup NGROK

• Run ngrok - point to port 3978

  ngrok http https://localhost: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

2. Setup for code

   • Clone the repository

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

• In a terminal, navigate to samples/tab-navbar-menu/ts

• Install modules

  npm install

  npm start

• The client will start running on 3978 port

4. Setup Manifest for Teams

• This step is specific to Teams.

  • Edit the manifest.json contained in the ./appManifest folder to replace your GUID and you see the place holder string {{GUID}} 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 (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 the Apps view click "Upload a custom app")

  • Go to Microsoft Teams. From the lower left corner, select Apps
  • From the lower left corner, choose Upload a custom App
  • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
  • Select Add in the pop-up dialog box. Your app is uploaded to Teams. Note The navbar menu app is supported only personal scopes.

Running the sample

Install App:

MainPage UI:

Clik 3 small dots (Includes other app options and information):

Click About Menu:

Clik 3 small dots (Includes other app options and information):

Click Contact Menu:

Clik 3 small dots (Includes other app options and information):

Further Reading

Configure and add multiple actions in NavBar