Skip to content

Commit b8de549

Browse files
committed
SPFx 1.7 docs
1 parent 8582657 commit b8de549

22 files changed

+1033
-156
lines changed

.vs/ProjectSettings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"CurrentProjectSetting": null
3+
}

.vs/VSWorkspaceState.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ExpandedNodes": [
3+
""
4+
],
5+
"PreviewInSolutionExplorer": false
6+
}

.vs/slnx.sqlite

824 KB
Binary file not shown.

.vs/sp-dev-docs/v15/.suo

10 KB
Binary file not shown.

docs/spfx/dynamic-data.md

Lines changed: 311 additions & 131 deletions
Large diffs are not rendered by default.

docs/spfx/extensions/get-started/build-a-hello-world-extension.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first SharePoint Framework Extension (Hello World part 1)
33
description: Create an extension project, and then code and debug your Application Customizer.
4-
ms.date: 08/30/2018
4+
ms.date: 11/8/2018
55
ms.prod: sharepoint
66
---
77

@@ -43,15 +43,15 @@ You can also follow the steps in this article by watching the video on the Share
4343
* Accept the default **app-extension** as your solution name, and select Enter.
4444
* Select **SharePoint Online only (latest)**, and select Enter.
4545
* Select **Use the current folder**, and select Enter.
46-
* Select **N** to require the extension to be installed on each site explicitly when it's being used.
46+
* Select **N** to allow solution to be deployed to all sites immediately.
47+
* Select **N** on the question if solution contains unique permissions.
4748
* Select **Extension** as the client-side component type to be created.
4849
* Select **Application Customizer** as the extension type to be created.
4950
5051
5. The next set of prompts ask for specific information about your extension. When prompted:
5152
5253
* Accept the default **HelloWorld** as your extension name, and select Enter.
5354
* Accept the default **HelloWorld description** as your extension description, and select Enter.
54-
* For the next question **Do you want to allow the tenant admin the choice of being able to deploy the solution to all sites....**, ensure you select No (N) , and select Enter. If you select Yes (y), the scaffolding will not generate the Elements.xml feature deployment file.
5555
5656
<br/>
5757
@@ -117,7 +117,7 @@ You cannot use the local Workbench to test SharePoint Framework Extensions. You
117117
118118
Notice that this file has been updated with the default settings matching your project. You can notice that there's a specific GUID mentioned under the customActions element. This is automatically updated to match your component when project was scaffold. If you will add new components or change the properties for the component, you will need to update this file for testing.
119119
120-
2. Update pageURL to match your own tenant, which you want to use for testing. You can use any URL with modern experience. *This could be for example a welcome page of a new group associated team site, which would mean somewhat following URL:
120+
2. Update pageURL to match your own tenant, which you want to use for testing. You can use any URL with modern experience. *This could be for example a welcome page of a new group associated team site, which would mean somewhat following URL:*
121121
122122
`https://sppnp.sharepoint.com/sites/yoursite/SitePages/Home.aspx`
123123

docs/spfx/extensions/get-started/building-simple-cmdset-with-dialog-api.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first ListView Command Set extension
33
description: Create an extension project, and then code and debug your extension by using SharePoint Framework (SPFx) Extensions.
4-
ms.date: 08/27/2018
4+
ms.date: 11/8/2018
55
ms.prod: sharepoint
66
---
77

@@ -42,7 +42,8 @@ You can follow these steps by watching the video on the SharePoint PnP YouTube C
4242
* Accept the default value of **command-extension** as your solution name, and then select Enter.
4343
* Select **SharePoint Online only (latest)**, and select Enter.
4444
* Select **Use the current folder**, and select Enter.
45-
* Select **N** to require the extension to be installed on each site explicitly when it's being used.
45+
* Select **N** to allow solution to be deployed to all sites immediately.
46+
* Select **N** on the question if solution contains unique permissions.
4647
* Select **Extension** as the client-side component type to be created.
4748
* Select **ListView Command Set** as the extension type to be created.
4849
@@ -346,6 +347,7 @@ Open **package-solution.json** from the **config** folder. The **package-solutio
346347
"id": "0abe5c73-1655-49d3-922b-7a47dd70e151",
347348
"version": "1.0.0.0",
348349
"includeClientSideAssets": true,
350+
"isDomainIsolated": false,
349351
"features": [
350352
{
351353
"title": "Application Extension - Deployment of custom action.",

docs/spfx/extensions/get-started/building-simple-field-customizer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first Field Customizer extension
33
description: Create an extension project, and then code and debug your extension by using SharePoint Framework (SPFx) Extensions.
4-
ms.date: 08/28/2018
4+
ms.date: 11/8/2018
55
ms.prod: sharepoint
66
---
77

@@ -42,7 +42,8 @@ You can follow these steps by watching the video on the SharePoint PnP YouTube C
4242
* Accept the default value of **field-extension** as your solution name, and then select Enter.
4343
* Select **SharePoint Online only (latest)**, and select Enter.
4444
* Select **Use the current folder**, and select Enter.
45-
* Select **N** to require the extension to be installed on each site explicitly when it's being used.
45+
* Select **N** to allow solution to be deployed to all sites immediately.
46+
* Select **N** on the question if solution contains unique permissions.
4647
* Select **Extension** as the client-side component type to be created.
4748
* Select **Field Customizer** as the extension type to be created.
4849
@@ -328,6 +329,7 @@ Notice also that by default **includeClientSideAssets** attribute is set to true
328329
"id": "80c04d1b-dca7-4d0a-86c0-9aedf904704f",
329330
"version": "1.0.0.0",
330331
"includeClientSideAssets": true,
332+
"isDomainIsolated": false,
331333
"features": [
332334
{
333335
"title": "Application Extension - Deployment of custom action.",

docs/spfx/extensions/get-started/serving-your-extension-from-sharepoint.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Deploy your extension to SharePoint (Hello World part 3)
33
description: Deploy your SharePoint Framework Application Customizer to SharePoint and see it working on modern SharePoint pages.
4-
ms.date: 08/27/2018
4+
ms.date: 11/8/2018
55
ms.prod: sharepoint
66
---
77

@@ -135,6 +135,7 @@ Your **package-solution.json** should look somewhat following after the needed e
135135
"id": "98a9fe4f-175c-48c1-adee-63fb927faa70",
136136
"version": "1.0.0.0",
137137
"includeClientSideAssets": true,
138+
"isDomainIsolated": false,
138139
"features": [
139140
{
140141
"title": "Application Extension - Deployment of custom action.",
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Building Microsoft Teams Tabs using SharePoint Framework
3+
description: You can build your Microsoft Teams tabs using SharePoint Framework and utilize the tooling
4+
ms.date: 11/08/2018
5+
ms.prod: sharepoint
6+
---
7+
8+
# Building Microsoft Teams Tabs using SharePoint Framework
9+
10+
Starting with SharePoint Framework v1.7, you can build your Microsoft Team tabs using SharePoint Framework tooling and use SharePoint as a host for your solutions.
11+
12+
There are following benefits on using SharePoint Framework as the platform for your Microsoft Teams tabs:
13+
14+
- Development model is similar as for SharePoint Framework web parts
15+
- Technically any web part can be exposed as a tab in the Microsoft
16+
- You have difference scoping options on exposing your custom tab as a web part and tab in your tenant
17+
- Your tab will be executed in the context of the underlaying SharePoint site behind of the specific team. This means that you can take advantage of any SharePoint specific APIs or functionalities in your web part.
18+
19+
> [!IMPORTANT]
20+
> This feature is currently in preview and is subject to change. It is not currently supported for use in production environments. Your feedback and input around this capability is welcome using the [SharePoint Dev Docs issue list](https://github.com/SharePoint/sp-dev-docs/issues).
21+
22+
## Development process
23+
24+
You can start developing Microsoft Teams tabs simply by using the `with beta` version of the SharePoint Framework 1.7 packages. High level steps to get started are as follows.
25+
26+
1. Start SharePoint Framework Yeoman generator with the `plusbeta` switch, so that the created solution will use the preview packages.
27+
28+
```
29+
yo @microsoft/sharepoint --plusbeta
30+
```
31+
32+
1. Create a solution with a client-side web part
33+
1. Deploy web part using tenant-scoped deployment option to your SharePoint app catalog
34+
1. Package `manifest.json` located in the `/teams` folder in your solution as a zip file . This file was automatically configured with default settings when your solution was created
35+
1. Deploy your zip file (application) to the Microsoft Teams and start add a new tab in the preferred channel
36+
37+
> [!NOTE]
38+
> You can also follow the detailed steps to get started from the [Building Microsoft Teams tab using SharePoint Framework](web-parts/get-started/using-web-part-as-ms-teams-tab.md) tutorial.
39+
40+
## Deployment options
41+
42+
There are few different options on getting the developed Microsoft Teams tab deployed. As both SharePoint and Microsoft Teams have their own app catalog, deployment requires operations on both services. Visibility of the new functionality can be controlled on the exact deployment mechanism.
43+
44+
Following table shows the deployment options in table style matrix. Top row shows the Microsoft Teams deployment options and first column mapped SharePoint deployment options.
45+
46+
| SharePoint/Teams deployment type | Manifest deployed to Store | Manifest deployed to Teams channel catalog |
47+
|-----------|------|-------------|
48+
| SharePoint tenant-scoped deployment | Solution available in all teams and all SharePoint sites | Solution available in specific team and all SharePoint Sites |
49+
| Site collection app catalog with tenant-scoped option in SharePoint site behind of the Team | Not an option | Solution is available in the specific site collection and specific team |
50+
| SharePoint site level deployment | Not an option | Solution is available in specific SharePoint site and in specific team |
51+
52+
See following resources for additional details around the different options in both systems:
53+
54+
- [Upload an app package to Microsoft Teams](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/apps/apps-upload)
55+
- [Tenant-scoped solution deployment for SharePoint Framework solutions](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment)
56+
57+
## Detecting if web part is in Teams context
58+
59+
Page context in a web part has by default a reference to the Teams JavaScript SDK, so that you can easily get access on the Teams context when your web part is rendered as a tab.
60+
61+
```javascript
62+
this.context.microsoftTeams
63+
```
64+
65+
> [!NOTE]
66+
> See more information around th Microsoft Teams tab context from the [Microsoft Teams development documentation](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/tabs/tabs-context?view=msteams-client-js-latest).
67+
68+
## See also
69+
70+
- [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)