Skip to content

Commit a0906e4

Browse files
authored
Teams JS Version to use
1 parent 6e5e456 commit a0906e4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/spfx/integrate-with-teams-introduction.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,15 @@ this.context.sdks.microsoftTeams
114114
>
115115
> You should use `this.context.sdks.microsoftTeams` for all solutions created with the SharePoint Framework v1.10 and later.
116116
117+
## What Teams JS SDK version to use?
118+
119+
The SharePoint Framework provides access to the Teams JS SDK instance and context using `sdks.microsoftTeams` property in the [context's API](https://docs.microsoft.com/en-us/javascript/api/sp-webpart-base/webpartcontext?view=sp-typescript-latest#@microsoft-sp-webpart-base-webpartcontext-sdks-member).
120+
Using this API assures the supported version of Teams JS is loaded and initialized.
121+
122+
Few crucial details to keep in mind:
123+
- Installing and initializing custom versions of Teams JS SDK is **unsupported**.
124+
- Although Teams JS SDK types are tied to the SPFx version used in the solution, the actual version loaded to the tenant may differ. We guarantee backward compatibility on our end. For example, a solution built with SPFx 1.14 will have types from Teams JS 1.10.0, and SPFx 1.15.2 will have types from Teams JS 1.12.1, but the actual loaded version can be 2.1.0.
125+
117126
## See also
118127

119128
- [Building Microsoft Teams tab using SharePoint Framework - Tutorial](web-parts/get-started/using-web-part-as-ms-teams-tab.md)

0 commit comments

Comments
 (0)