@microsoft/teams-js
Advanced tools
@microsoft/teams-js - npm Package Compare versions
Comparing version 1.2.1 to 1.2.2
| { | ||
| "name": "@microsoft/teams-js", | ||
| "author": "Microsoft Teams", | ||
| "version": "1.2.1", | ||
| "version": "1.2.2", | ||
| "description": "Microsoft Client SDK for building app for Microsoft teams", | ||
@@ -6,0 +6,0 @@ "main": "./dist/MicrosoftTeams.min.js", |
| # [Microsoft Teams JavaScript Library](https://msdn.microsoft.com/en-us/microsoft-teams/) | ||
| This JavaScript library is part of the [Microsoft Teams developer platform](https://msdn.microsoft.com/en-us/microsoft-teams/). For documentation, see [Reference: Microsoft Teams JavaScript library](https://msdn.microsoft.com/en-us/microsoft-teams/jslibrary). | ||
| This JavaScript library is part of the [Microsoft Teams developer platform](https://msdn.microsoft.com/en-us/microsoft-teams/). For documentation, see [Reference: Microsoft Teams JavaScript library](https://docs.microsoft.com/en-us/javascript/api/overview/msteams-client). | ||
| [](https://travis-ci.org/OfficeDev/microsoft-teams-library-js) | ||
| ## Get Started | ||
| ## Getting Started | ||
| 1. Clone the repo | ||
@@ -13,2 +13,41 @@ 2. Navigate to the repo root | ||
| ### Installation | ||
| #### Development | ||
| > This assumes you are using npm as your package manager. | ||
| To install the stable version: | ||
| `npm install --save @microsoft/teams-js` | ||
| #### Production | ||
| You can access [these files on unpkg](https://unpkg.com/@microsoft/teams-js@1.2.1/dist/MicrosoftTeams.min.js), download them, or point your package manager to them. | ||
| ## Usage | ||
| ### JavaScript | ||
| Reference the library inside of your `.html` page using: | ||
| ```html | ||
| <!-- Microsoft Teams JavaScript API (via CDN) --> | ||
| <script src="https://unpkg.com/@microsoft/teams-js@1.2.1/dist/MicrosoftTeams.min.js"></script> | ||
| <!-- Microsoft Teams JavaScript API (via npm) --> | ||
| <script src="node_modules/@microsoft/teams-js@1.2.1/dist/MicrosoftTeams.min.js"></script> | ||
| <!-- Microsoft Teams JavaScript API (via local) --> | ||
| <script src="MicrosoftTeams.min.js"></script> | ||
| ``` | ||
| ### TypeScript | ||
| **If you are just referencing the library using a script tag** then make sure to set your `moduleResolution` to `node` in your tsconfig.json to pickup the intellisense automatically. You will need to install the package via `npm install @microsoft/teams-js`. | ||
| **If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use TypeScript `import` syntax to import specific modules. For e.g. | ||
| ```typescript | ||
| import * as microsoftTeams from '@microsoft/microsoft-teams-library-js'; | ||
| ## Contributing | ||
@@ -15,0 +54,0 @@ We strongly welcome and encourage contributions to this project. Please read the [contributor's guide](CONTRIBUTING.md). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.85%
86349
- Number of lines in readme file
- increased by205.26%
58
- Number of medium supply chain risk alerts
- decreased by-100%
0