@microsoft/teams-js
Advanced tools
Comparing version 1.2.3 to 1.2.4-beta.1
{ | ||
"name": "@microsoft/teams-js", | ||
"author": "Microsoft Teams", | ||
"version": "1.2.3", | ||
"version": "1.2.4-beta.1", | ||
"description": "Microsoft Client SDK for building app for Microsoft teams", | ||
@@ -6,0 +6,0 @@ "main": "./dist/MicrosoftTeams.min.js", |
@@ -14,25 +14,37 @@ # [Microsoft Teams JavaScript Library](https://msdn.microsoft.com/en-us/microsoft-teams/) | ||
### Installation | ||
To install the stable version: | ||
#### Development | ||
> This assumes you are using npm as your package manager. | ||
#### npm | ||
To install the stable version: | ||
`npm install --save @microsoft/teams-js` | ||
#### yarn | ||
`yarn add @microsoft/teams-js` | ||
#### Production | ||
You can access [these files on unpkg](https://unpkg.com/@microsoft/teams-js@1.2.3/dist/MicrosoftTeams.min.js), download them, or point your package manager to them. | ||
You can access [these files on unpkg](https://unpkg.com/@microsoft/teams-js@1.2.2/dist/MicrosoftTeams.min.js), download them, or point your package manager to them. | ||
## Usage | ||
### JavaScript | ||
### As a npm package | ||
Install either using npm or yarn | ||
**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 `import` syntax to import specific modules. For e.g. | ||
```typescript | ||
import * as microsoftTeams from '@microsoft/teams-js'; | ||
``` | ||
### As a Script Tag | ||
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.3/dist/MicrosoftTeams.min.js"></script> | ||
<script src="https://unpkg.com/@microsoft/teams-js@1.2.2/dist/MicrosoftTeams.min.js" integrity="sha384-fTjWNTelhUDsOG+6Xvsly5BVO8estmdrfVmaRQuTGRTtcjHYA3oQANo805/kHXvJ" crossorigin="anonymous"></script> | ||
<!-- Microsoft Teams JavaScript API (via npm) --> | ||
<script src="node_modules/@microsoft/teams-js@1.2.3/dist/MicrosoftTeams.min.js"></script> | ||
<script src="node_modules/@microsoft/teams-js@1.2.2/dist/MicrosoftTeams.min.js"></script> | ||
@@ -43,12 +55,2 @@ <!-- Microsoft Teams JavaScript API (via local) --> | ||
### 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 | ||
@@ -59,2 +61,2 @@ We strongly welcome and encourage contributions to this project. Please read the [contributor's guide](CONTRIBUTING.md). | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
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
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
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
59
86153
2