Natural Preference for Minification

    @microsoft/teams-js
    TypeScript icon, indicating that this package has built-in type declarations

    2.5.0 • Public • Published

    Microsoft Teams JavaScript client library

    Welcome to the Teams JavaScript client library! For breaking changes, please refer to our changelog in the current <root>/packages/teams-js directory.

    This JavaScript library is part of the Microsoft Teams developer platform. See full library reference documentation.

    Getting Started

    See instructions in the monorepo root for how to clone and build the repository.

    Whenever building or testing the Teams client library, you can run yarn build or yarn test from the packages/teams-js directory.

    Installation

    To install the stable version:

    npm

    npm install --save @microsoft/teams-js

    yarn

    yarn add @microsoft/teams-js

    Production

    You can reference these files directly from here or point your package manager at them.

    Usage

    As a 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 { app } 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://res.cdn.office.net/teams-js/2.5.0/js/MicrosoftTeams.min.js"
      integrity="sha384-0lOzlvRkoNWAcLkbUTuao6TaDa7zI7v+q2PUAm3lrMxUp43PFwf2kaQu7FYT9fjS"
      crossorigin="anonymous"
    ></script>
    
    <!-- Microsoft Teams JavaScript API (via npm) -->
    <script src="node_modules/@microsoft/teams-js@2.5.0/dist/MicrosoftTeams.min.js"></script>
    
    <!-- Microsoft Teams JavaScript API (via local) -->
    <script src="MicrosoftTeams.min.js"></script>

    Dependencies

    Teams client library depends on Promise type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as es6-promise, in your bundled application. If you're using a script tag to reference the Teams client library, you need to make sure the polyfill is included and initialized before the Teams client library is initialized.

    Examples

    Stay tuned for examples coming soon.

    Testing

    The Teams Test App is used to validate the Teams client library APIs.

    Troubleshooting

    If the CDN hash value on the npm page is out of date please refer to [here] (https://github.com/OfficeDev/microsoft-teams-library-js/blob/main/packages/teams-js/README.md) for an up to date version. If you notice this problem, please report that issue to us in [GitHub Issues] (https://github.com/OfficeDev/microsoft-teams-library-js/issues)

    Contributing

    Please be sure to check out the Contributor's guide for crucial steps.

    Keywords

    none

    Install

    npm i @microsoft/teams-js

    DownloadsWeekly Downloads

    76,000

    Version

    2.5.0

    License

    MIT

    Unpacked Size

    1.99 MB

    Total Files

    8

    Last publish

    Collaborators

    • microsoft1es
    • hexteam
    • vsrdomain