@microsoft/teams-js 1.11.0-dev.3 → 2.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -16
- package/dist/MicrosoftTeams.d.ts +4782 -5
- package/dist/MicrosoftTeams.js +5084 -3536
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +2 -1
- package/dist/MicrosoftTeams.min.js.map +1 -0
- package/package.json +27 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Microsoft Teams JavaScript client SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Welcome to the Teams client SDK monorepo! For breaking changes, please refer to our changelog in the monorepo root.
|
|
4
|
+
|
|
5
|
+
This JavaScript library is part of the [Microsoft Teams developer platform](https://developer.microsoft.com/microsoft-teams/). See full [SDK reference documentation](https://docs.microsoft.com/en-us/javascript/api/overview/msteams-client).
|
|
4
6
|
|
|
5
7
|
[](https://travis-ci.org/OfficeDev/microsoft-teams-library-js)
|
|
6
8
|
[](https://coveralls.io/github/OfficeDev/microsoft-teams-library-js?branch=master)
|
|
@@ -8,26 +10,27 @@ This SDK is part of the [Microsoft Teams developer platform](https://developer.m
|
|
|
8
10
|
## Getting Started
|
|
9
11
|
|
|
10
12
|
1. Clone the repo
|
|
11
|
-
2. Navigate to the repo root
|
|
12
|
-
3. `yarn
|
|
13
|
-
4. `yarn
|
|
14
|
-
|
|
13
|
+
2. Navigate to the repo root and run `yarn install`
|
|
14
|
+
3. `yarn build` from repo root
|
|
15
|
+
4. to run Unit test `yarn test`
|
|
16
|
+
|
|
17
|
+
TIP: whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
|
|
15
18
|
|
|
16
|
-
|
|
19
|
+
## Installation
|
|
17
20
|
|
|
18
|
-
To install the
|
|
21
|
+
To install the latest 2.0 preview version:
|
|
19
22
|
|
|
20
|
-
|
|
23
|
+
### npm
|
|
21
24
|
|
|
22
|
-
`npm install --save @microsoft/teams-js`
|
|
25
|
+
`npm install --save @microsoft/teams-js@next`
|
|
23
26
|
|
|
24
|
-
|
|
27
|
+
### yarn
|
|
25
28
|
|
|
26
|
-
`yarn add @microsoft/teams-js`
|
|
29
|
+
`yarn add @microsoft/teams-js@next`
|
|
27
30
|
|
|
28
|
-
|
|
31
|
+
### Production
|
|
29
32
|
|
|
30
|
-
You can access [these files on unpkg](https://
|
|
33
|
+
You can access [these files on unpkg](https://res.cdn.office.net/teams-js/2.0.0-beta.0/js/MicrosoftTeams.min.js), download them, or point your package manager to them.
|
|
31
34
|
|
|
32
35
|
## Usage
|
|
33
36
|
|
|
@@ -38,7 +41,7 @@ Install either using npm or yarn.
|
|
|
38
41
|
**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.
|
|
39
42
|
|
|
40
43
|
```typescript
|
|
41
|
-
import
|
|
44
|
+
import { app } from '@microsoft/teams-js';
|
|
42
45
|
```
|
|
43
46
|
|
|
44
47
|
### As a script tag
|
|
@@ -47,15 +50,31 @@ Reference the SDK inside of your `.html` page using:
|
|
|
47
50
|
|
|
48
51
|
```html
|
|
49
52
|
<!-- Microsoft Teams JavaScript API (via CDN) -->
|
|
50
|
-
<script
|
|
53
|
+
<script
|
|
54
|
+
src="https://res.cdn.office.net/teams-js/2.0.0-beta.0/js/MicrosoftTeams.min.js"
|
|
55
|
+
integrity="sha384-6oUzHUqESdbT3hNPDDZUa/OunUj5SoxuMXNek1Dwe6AmChzqc6EJhjVrJ93DY/Bv"
|
|
56
|
+
crossorigin="anonymous"
|
|
57
|
+
></script>
|
|
51
58
|
|
|
52
59
|
<!-- Microsoft Teams JavaScript API (via npm) -->
|
|
53
|
-
<script src="node_modules/@microsoft/teams-js@
|
|
60
|
+
<script src="node_modules/@microsoft/teams-js@2.0.0-beta.0/dist/MicrosoftTeams.min.js"></script>
|
|
54
61
|
|
|
55
62
|
<!-- Microsoft Teams JavaScript API (via local) -->
|
|
56
63
|
<script src="MicrosoftTeams.min.js"></script>
|
|
57
64
|
```
|
|
58
65
|
|
|
66
|
+
### Dependencies
|
|
67
|
+
|
|
68
|
+
Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
|
|
69
|
+
|
|
70
|
+
## Examples
|
|
71
|
+
|
|
72
|
+
Stay tuned for examples coming soon.
|
|
73
|
+
|
|
74
|
+
## Testing
|
|
75
|
+
|
|
76
|
+
The [Teams Test App](/apps/teams-test-app/README.md) is used to validate the Teams client SDK APIs.
|
|
77
|
+
|
|
59
78
|
## Contributing
|
|
60
79
|
|
|
61
80
|
We strongly welcome and encourage contributions to this project. Please read the [contributor's guide](CONTRIBUTING.md).
|