Skip to content

Commit e18cc51

Browse files
waldekmastykarzVesaJuvonen
authored andcommitted
Updated guidance on SPFx development for SP2016 FP2 (SharePoint#955)
1 parent 1a90930 commit e18cc51

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

docs/spfx/sharepoint-2016-support.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,21 @@ ms.date: 09/25/2017
55

66
# SharePoint Framework development with SharePoint 2016 Feature Pack 2
77

8-
SharePoint 2016 Feature Pack 2 supports SharePoint Framework client-side web parts hosted in classic SharePoint pages.
8+
SharePoint 2016 Feature Pack 2 supports SharePoint Framework client-side web parts hosted in classic SharePoint pages.
99

10-
An introduction to SharePoint Framework development in SharePoint 2016 using Feature Pack 2 is also covered in the following video on the [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=LGLMxnmHk6U&list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG).
10+
An introduction to SharePoint Framework development in SharePoint 2016 using Feature Pack 2 is also covered in the following video on the [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=LGLMxnmHk6U&list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG).
1111

1212
> [!VIDEO https://www.youtube.com/embed/LGLMxnmHk6U?list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG]
1313
1414
## Which version of the SharePoint Framework to use
1515

16-
Since SharePoint Online and SharePoint 2016 have different release cycles for new capabilities, they also have different capabilities when it comes to the SharePoint Framework. SharePoint Online always uses the latest version of the SharePoint Framework, but SharePoint 2016 only supports the version which matches the server-side dependencies of the deployed packages.
16+
Since SharePoint Online and SharePoint 2016 have different release cycles for new capabilities, they also have different capabilities when it comes to the SharePoint Framework. SharePoint Online always uses the latest version of the SharePoint Framework, but SharePoint 2016 only supports the version which matches the server-side dependencies of the deployed packages.
1717

18-
SharePoint 2016 Feature Pack 2 supports SharePoint Framework client-side web parts hosted in classic SharePoint pages built using the SharePoint Framework v1.0. This means that when you are targeting the SharePoint 2016 platform, you'll need to use the SharePoint Framework v1.0.2 due to the server-side version dependencies.
18+
SharePoint 2016 Feature Pack 2 supports SharePoint Framework client-side web parts hosted in classic SharePoint pages built using the SharePoint Framework v1.1.0. This means that when you are targeting the SharePoint 2016 platform, you'll need to use the SharePoint Framework v1.1.0 due to the server-side version dependencies.
1919

20-
If you are planning to use the same client-side web parts in both SharePoint 2016 and in SharePoint Online, you will need to use the SharePoint Framework v1.0.2 as your baseline version to ensure that the web part works in both environments.
20+
If you are planning to use the same client-side web parts in both SharePoint 2016 and in SharePoint Online, you will need to use the SharePoint Framework v1.1.0 as your baseline version to ensure that the web part works in both environments.
2121

22-
## Installing the SharePoint Framework version needed for SP2016 development
23-
24-
You should ensure that you are using the right version of the SharePoint Framework on your development machine. You can check the currently globally installed SharePoint Framework Yeoman template package version using the following command:
25-
26-
```
27-
npm list -g --depth 0
28-
```
29-
30-
This will list the globally installed packages, including their versions. If the `@microsoft/generator-sharepoint` package version is incorrect, you can uninstall the generator by using the following command:
31-
32-
```
33-
npm uninstall -g @microsoft/generator-sharepoint
34-
```
35-
36-
To install v1.0.2 of the SharePoint Framework Yeoman templates, you can use the following command:
37-
38-
```
39-
npm install -g @microsoft/[email protected]
40-
```
22+
Starting from version 1.3, the SharePoint Framework Yeoman generator supports scaffolding solutions both that use the latest version of the SharePoint Framework meant for use with SharePoint Online, and solutions that can be used also with SharePoint on-premises based on the v1.1.0 of the SharePoint Framework. You don't need to install a separate version of the SharePoint Framework Yeoman generator to scaffold solutions meant for use with SharePoint on-premises.
4123

4224
## Hosting your SharePoint Framework solution for on-premises deployment
4325

@@ -54,13 +36,13 @@ You can host the JavaScript files in the ___location that best fits your environmen
5436

5537
> You can find more details on blocked file types in SharePoint 2016 from the following support article: [Types of files that cannot be added to a list or library](https://support.office.com/en-us/article/Types-of-files-that-cannot-be-added-to-a-list-or-library-30be234d-e551-4c2a-8de8-f8546ffbf5b3#ID0EAADAAA=2016)
5638
57-
## Development environment considerations
39+
## Development environment considerations
5840

5941
When you are developing SharePoint Framework client-side web parts you need Internet connectivity to access npm packages. This is required when solutions are being scaffolded using the SharePoint Framework Yeoman templates.
6042

6143
If Internet access is not available for the development machines, you can setup a local on-premises registry for the required npm packages. However, this requires additional software and a significant amount of work to setup and maintain local package versions with packages in the actual npm gallery.
6244

63-
> The [Team-based development on the SharePoint Framework](team-based-development-on-sharepoint-framework.md) guidance document includes different options for development environment setup including when you might need to support multiple SharePoint Framework versions.
45+
> The [Team-based development on the SharePoint Framework](team-based-development-on-sharepoint-framework.md) guidance document includes different options for development environment setup including when you might need to support multiple SharePoint Framework versions.
6446
6547
## How to determine which SharePoint Framework version was used for a solution
6648

@@ -69,4 +51,4 @@ If you have existing SharePoint Framework solutions and you'd like to confirm wh
6951
- **.yo-rc.json** - file in the solution's root folder that stores the SharePoint Framework Yeoman template version used when the solution was created.
7052
- **package.json** - file in the solution's root folder that contains references to package versions used in the solution.
7153
- **npm-shrinkwrap.json** - file in the solution's root folder that contains information about the exact versions used (if you used the `npm shrinkwrap` command to lock-down the exact versions of the solution).
72-
-- **package.json** - file in the *node_modules/@microsoft/sp-webpart-base* folder that contains a *version* attribute matching the used SharePoint Framework version, if you have installed packages to your solution.
54+
- **package.json** - file in the *node_modules/@microsoft/sp-webpart-base* folder that contains a *version* attribute matching the used SharePoint Framework version, if you have installed packages to your solution.

0 commit comments

Comments
 (0)