@microsoft/teams-js

What is @microsoft/teams-js?

@microsoft/teams-js is a JavaScript library that allows developers to integrate their web applications with Microsoft Teams. It provides a set of APIs to interact with Teams features such as authentication, notifications, and user context.

What are @microsoft/teams-js's main functionalities?

Authentication

This feature allows you to authenticate users within your Teams application. The code sample demonstrates how to initiate an authentication flow using the `microsoftTeams.authentication.authenticate` method.

const microsoftTeams = require('@microsoft/teams-js');
microsoftTeams.authentication.authenticate({
  url: window.location.origin + '/auth-start',
  width: 600,
  height: 535,
  successCallback: (result) => {
    console.log('Authentication successful:', result);
  },
  failureCallback: (reason) => {
    console.log('Authentication failed:', reason);
  }
});

Notifications

This feature allows you to show notifications to users within your Teams application. The code sample demonstrates how to display a notification using the `microsoftTeams.notifications.showNotification` method.

const microsoftTeams = require('@microsoft/teams-js');
microsoftTeams.notifications.showNotification({
  message: 'This is a notification',
  duration: 3000
});

User Context

This feature allows you to retrieve the context of the user within Teams. The code sample demonstrates how to get the user context using the `microsoftTeams.getContext` method.

const microsoftTeams = require('@microsoft/teams-js');
microsoftTeams.getContext((context) => {
  console.log('User context:', context);
});

Other packages similar to @microsoft/teams-js

botbuilder

The `botbuilder` package is part of the Microsoft Bot Framework and allows developers to create bots that can interact with users in Microsoft Teams. It provides functionalities for handling messages, dialogs, and other interactions within Teams, making it a good alternative for building conversational experiences.

office-js

The `office-js` package is used for developing Office Add-ins, including those for Microsoft Teams. It provides APIs to interact with Office applications and services, and can be used to extend the functionality of Teams by integrating with other Office 365 services.

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

1. Clone the repo
2. Navigate to the repo root
3. yarn install
4. gulp

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.3.3/dist/MicrosoftTeams.min.js" integrity="sha384-g1iQyAjC6TaAEj70a8TEV96chNDvgDxIjqEdppo/wph3gPqZ60d7lA1mxDUkAETe" crossorigin="anonymous"></script>

<!-- Microsoft Teams JavaScript API (via npm) -->
<script src="node_modules/@microsoft/teams-js@1.3.3/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 [e-mail] with any additional questions or comments.