page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This tab app showcases the People Picker functionality using the Teams JavaScript client SDK to allow users to select individuals from their organization. |
|
|
|
officedev-microsoft-teams-samples-tab-people-picker-nodejs |
This sample application demonstrates the People Picker feature within a Microsoft Teams tab, utilizing the Teams JavaScript client SDK to facilitate seamless user selection from an organization's member list. With capabilities for both scoped and organization-wide searches, along with intuitive single-select functionality, this app enhances collaboration by simplifying the process of connecting with colleagues in Teams.
- Tabs
- People Picker in tabs
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 people picker: Manifest
-
Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.
-
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 tunnelling solution
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 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-people-picker/nodejs
-
Install modules
npm install
-
Run your bot at the command line:
npm start
-
This step is specific to Teams.
-
Edit the
manifest.json
contained in theappManifest
folder to replace {{Manifest-id}} with any GUID -
{{base-url}}
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. Replace everywhere you see the place holder string{{base-url}}
Note => UpdatevalidDomains
as per your application domain, if needed. -
Zip up the contents of the
appManifest
folder to create amanifest.zip
-
Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
-
Adding tab people picker UI:
Tab UI:
All Memberes Of Organisation Search:
Scope search:
Single Select:
Set Selected Search: