Finding the SDK
The Teams client SDK is distributed as an npm package. The latest version can be found here: https://www.npmjs.com/package/@microsoft/teams-js.
Installing the SDK
You can install the package using npm or yarn:
npm install --save @microsoft/teams-js
yarn add @microsoft/teams-js
Using the SDK
import * as microsoftTeams from "@microsoft/teams-js";
You can also reference the entire library in html pages using a script tag. There are three ways to do this:
Do not copy/paste these
<script src=... URLs from this page; they refer to a specific version of the SDK. To get the
<script src=...></script> markup for the latest version, always go to https://www.npmjs.com/package/@microsoft/teams-js.
The first method, using unpkg.com, is probably the most practical unless you prefer not to use a third-party party service like unpkg.com. The final option, using a local copy on your servers, eliminates that dependency but requires hosting and updating a local copy of the SDK.
If you are a TypeScript developer it is helpful to install the NPM package as described above, even if you don't link to the copy of
node_modules from your HTML, because IDEs such as Visual Studio Code will use it for Intellisense and type checking.
The following sections contain reference pages for all the elements of the Teams client API. These pages are auto-generated from the source found in the npm module on https://www.npmjs.com/package/@microsoft/teams-js. The source code for the SDK is located at https://github.com/OfficeDev/microsoft-teams-library-js.
And remember that The Microsoft Teams developer platform has full documentation on using the platform and the SDK.
Send feedback about: