Package Exports
- @microsoft/teams-js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@microsoft/teams-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Microsoft Teams JavaScript Library
This JavaScript library is part of the Microsoft Teams developer platform. For documentation, see Reference: Microsoft Teams JavaScript library.
Getting Started
- Clone the repo
- Navigate to the repo root
yarn installyarn build- to run Unit test
yarn test
Installation
To install the stable version:
npm
npm install --save @microsoft/teams-js
yarn
yarn add @microsoft/teams-js
Production
You can access these files on unpkg, download them, or point your package manager to them.
Usage
As a npm package
Install either using npm or yarn
If you are using any dependency loader such as RequireJS or SystemJS or module bundler such as browserify, webpack, you can use import syntax to import specific modules. For e.g.
import * as microsoftTeams from "@microsoft/teams-js";As a Script Tag
Reference the library inside of your .html page using:
<!-- Microsoft Teams JavaScript API (via CDN) -->
<script src="https://unpkg.com/@microsoft/teams-js@1.4.1-beta.0/dist/MicrosoftTeams.min.js" integrity="sha384-PRKCLBNsMU/jsrbInaEek1oFGx4fmfTaG3l5nEjTAP20P1SWWdPmYsD//oHgYFIB" crossorigin="anonymous"></script>
<!-- Microsoft Teams JavaScript API (via npm) -->
<script src="node_modules/@microsoft/teams-js@1.4.1-beta.0/dist/MicrosoftTeams.min.js"></script>
<!-- Microsoft Teams JavaScript API (via local) -->
<script src="MicrosoftTeams.min.js"></script>Contributing
We strongly welcome and encourage contributions to this project. Please read the contributor's guide.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.