You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Final edit
* Final edit
* Final tweaks
* Edit in progress
* Final edit
* Final edit
* Moved Design out of Concepts
* Fixed TOC errors
* Fixed broken links
* Moved item in TOC
* Moved tools and libraries up one level
title: Known issues and frequently asked questions
3
-
ms.date: 09/25/2017
2
+
title: SharePoint Framework known issues and frequently asked questions
3
+
description: Find answers to issues and FAQ about the SharePoint Framework.
4
+
ms.date: 01/12/2018
4
5
ms.prod: sharepoint
5
6
---
6
7
7
8
8
-
# Known issues and frequently asked questions
9
+
# SharePoint Framework known issues and frequently asked questions
9
10
10
-
This page is for listing any known issues or to answer any frequently asked questions around SharePoint Framework.
11
+
This page is for listing any known issues or to answer any frequently asked questions about SharePoint Framework.
11
12
12
13
## Known issues
13
14
14
-
**Dev certificate issue with Chrome (v58-)**
15
+
### Dev certificate issue with Chrome (v58-)
15
16
16
-
-*Date - 28th of April*
17
-
-*Updated - 2nd of May*
17
+
-*Date - April 28, 2017*
18
+
-*Updated - May 2, 2017*
18
19
19
-
If you are using Chrome as your development browser, you might have challenges with the developer certificate regardless of executing `gulp trust-dev-cert` command. Chrome has changed its model for certificate validation starting from version 58 and you might see "Your connection is not private" warning when you are accessing the local workbench.
20
+
If you are using Chrome as your development browser, you might have challenges with the developer certificate regardless of executing the `gulp trust-dev-cert` command. Chrome has changed its model for certificate validation starting from version 58, and you might see a "Your connection is not private" warning when you are accessing the local workbench.
20
21
21
-
You should update your Yeoman template packages. We have updated certification creation logic in the *@microsoft/gulp-core-build-serve* package. In existing solutions, you can simply delete this folder and run `npm install` to get the updated package. You will also need to execute `untrust-dev-cert` and `trust-dev-cert` commands in your machine to address the certification creation logic issue.
22
+
You should update your Yeoman template packages. We have updated certification creation logic in the [*@microsoft/gulp-core-build-serve* package](https://www.npmjs.com/package/@microsoft/gulp-core-build-serve).
23
+
24
+
In existing solutions, you can simply delete this folder and run `npm install` to get the updated package. You also need to execute `untrust-dev-cert` and `trust-dev-cert` commands on your machine to address the certification creation logic issue.
22
25
23
26
## Frequently asked questions
24
27
25
-
**When will custom actions and JSLink be available in the SharePoint Framework?**
28
+
### When will custom actions and JSLink be available in the SharePoint Framework?
26
29
27
-
-*Date - 6th of June*
30
+
-*Date - June 6, 2017*
28
31
29
-
SharePoint Framework Extensions with additional customizations capabilities is now available in SharePoint Online. You can find more details on the SharePoint Framework extensions from our documentation.
32
+
SharePoint Framework Extensions with additional customization capabilities is now available in SharePoint Online. You can find more information about SharePoint Framework Extensions from our documentation:
**Will SharePoint Framework be available in on-premises?**
37
+
### Will SharePoint Framework be available in on-premises?
35
38
36
-
-*Date - 6th of June*
39
+
-*Date - June 6, 2017*
37
40
38
-
SharePoint Framework client-side web parts on classic pages were released to SharePoint 2016 as part of the Feature Pack 2 (FP2). There are no plans currently to provide SharePoint Framework capabilities to SharePoint 2013. There's no specific list of SharePoint Framework capabilities which will be included in the SharePoint 2019 release.
41
+
SharePoint Framework client-side web parts on classic pages were released to SharePoint 2016 as part of the Feature Pack 2 (FP2). There are no plans currently to provide SharePoint Framework capabilities to SharePoint 2013. There's no specific list of SharePoint Framework capabilities that will be included in the SharePoint 2019 release.
39
42
40
43
## See also
41
-
Please use following resources to provide feedback, comments and questions towards SharePoint engineering.
description: Key modern customization capabilities released after General Availability.
4
+
ms.date: 01/12/2018
4
5
ms.prod: sharepoint
5
6
---
6
7
7
-
8
8
# SharePoint Framework roadmap
9
9
10
-
First release of the SharePoint Framework contained only support for client-side web parts. This was however just a start on the journey for providing additional modern customization capabilities to SharePoint. Here is a list of key capabilities released after initial General Availability.
10
+
The first release of the SharePoint Framework contained only support for client-side web parts. This was, however, just a start on the journey for providing additional modern customization capabilities to SharePoint. Following is a list of key capabilities released after General Availability:
-[Asset packaging and site collection app catalog](../general-development/site-collection-app-catalog.md)
18
+
-[Asset packaging and site collection App Catalog](../general-development/site-collection-app-catalog.md)
19
19
20
20
21
21
> [!NOTE]
22
-
> This is a list of areas which SharePoint engineering is having in the backlog and are looking into. This does **NOT** mean that all of them will be necessarily delivered, but we are looking for getting items and topics from this list gradually released with the future releases of SharePoint Framework.
22
+
> This is a list of areas that SharePoint engineering has in the backlog and is looking into. This does **NOT** mean that all of them will be delivered, but we are looking into getting items and topics from this list gradually released with the future releases of SharePoint Framework.
23
23
24
24
## General improvements
25
25
@@ -30,62 +30,63 @@ First release of the SharePoint Framework contained only support for client-side
30
30
31
31
## Client-side web parts++ and add-ins
32
32
33
-
-Supporting more complex scenarios and interactions with web parts
33
+
-Support more complex scenarios and interactions with web parts
34
34
- Part-to-part communication
35
-
- JS Framework isolation
36
-
- "citizen developer" model for lightweight development
35
+
- JavaScript Framework isolation
36
+
- "Citizen developer" model for lightweight development
37
37
38
-
- Bring add-ins to the modern world: Let’s make them play nicer with the new UX.
39
-
- Azure AD Registration
38
+
- Bring add-ins to the modern world: let’s make them play nicer with the new UX
39
+
- Azure AD registration
40
40
- Native responsive support
41
-
- Build Add-Ins with SharePoint Framework
41
+
- Build add-ins with SharePoint Framework
42
42
43
43
44
44
## Application Lifecycle Management
45
45
46
46
- Streamlined approval experience: no need to know who your tenant admin is anymore
47
-
- Owner initiates the approval process
48
-
- Tenant admin gets automatically notified
49
-
- Settings to control the default experience around approval process
47
+
- Owner initiates the approval process.
48
+
- Tenant admin gets automatically notified.
49
+
- Settings to control the default experience around approval process.
50
+
50
51
52
+
## Developer experience
51
53
52
-
## Developer Experience
53
54
- SharePoint Framework Workbench 2.0: Development story for SharePoint Framework Extensions
54
-
-Tool Chain Components
55
-
- Additional Yeoman Templates
55
+
-Toolchain components
56
+
- Additional Yeoman templates
56
57
57
58
## Already shipped capabilities
58
59
59
-
Following chapters are listing older items in the roadmap page, which have been already shipped.
60
+
The following sections list older items that have already shipped.
60
61
61
62
### Asset packaging
62
63
63
-
- Automatic CDN hosting for code - Package JavaScript bundle into app package, which is automatically then deployed to a library that gets hosted on your tenant Office 365 CDN
64
+
- Automatic CDN hosting for code. Package JavaScript bundle into app package, which is automatically deployed to a library that gets hosted on your tenant Office 365 CDN.
64
65
65
66
### ALM REST APIs
66
67
67
-
- ALM REST APIs - Deploy, activate, delete and upgrade apps and add-ins
68
-
- ALM REST APIs targeted to support *everything* in the App Catalog, including add-ins
69
-
- CSOM and PowerShell cmdlets released as an open source community initiative
68
+
- ALM REST APIs. Deploy, activate, delete, and upgrade apps and add-ins.
69
+
- ALM REST APIs targeted to support *everything* in the App Catalog, including add-ins.
70
+
- CSOM and PowerShell cmdlets released as an open source community initiative.
70
71
71
72
### JavaScript embedding support (JSLink, User Custom Actions)
72
73
73
-
- The same tool chain and deployment model as client-side web parts
74
-
- Derive from a strongly typed base class wherever possible rather than manipulating the page DOM directly.
75
-
- Enable modern extension usage with modern experiences similar as Custom Actions and JS Link in classic experience
76
-
- Work with NoScript via tenant app catalog
74
+
- The same toolchain and deployment model as client-side web parts.
75
+
- Derive from a strongly typed base class wherever possible, rather than manipulating the page DOM directly.
76
+
- Enable modern extension usage with modern experiences similar to Custom Actions and JSLink in classic experience.
77
+
- Work with NoScript via tenant App Catalog.
77
78
78
79
### On-premises support - Sharepoint 2016 Feature Pack 2
79
80
80
-
- Shipping as part of Feature Pack 2 for SharePoint 2016
81
-
- Similar feature capabilities as in SharePoint Online
82
-
- Target is to provide common development platform across on-premises and the cloud
83
-
- Leveraging modern toolchain and open source on on-premises environments
84
-
- Targeting SharePoint 2016 version during calendar year 2017
81
+
- Shipping as part of Feature Pack 2 for SharePoint 2016.
82
+
- Similar feature capabilities as in SharePoint Online.
83
+
- Target is to provide common development platform across on-premises and the cloud.
84
+
- Leveraging modern toolchain and open source in on-premises environments.
85
+
- Targeting SharePoint 2016 version during calendar year 2017.
85
86
86
87
87
88
## See also
88
-
Please use following resources to stay up to date on the new releases and capabilities being released for SharePoint Framework.
# Scaffold projects using yeoman SharePoint generator
1
+
---
2
+
title: Scaffold projects by using Yeoman SharePoint generator
3
+
description: Use the Yeoman SharePoint generator to scaffold new client-side solution projects to build, package, and deploy SharePoint solutions.
4
+
ms.date: 01/12/2018
5
+
ms.prod: sharepoint
6
+
---
2
7
3
-
[Yeoman](http://yeoman.io/) helps you to kickstart new projects, prescribing best practices and tools to help you stay productive. Using the yeoman SharePoint generator, developers are able to scaffold new client-side solution projects to build, package and deploy SharePoint solutions. The generator provides common build tools, boilerplate code, and a common playground web site to host web parts for testing.
8
+
# Scaffold projects by using Yeoman SharePoint generator
4
9
5
-
## Installing the yeoman SharePoint generator
10
+
[Yeoman](http://yeoman.io/) helps you to kickstart new projects, prescribing best practices and tools to help you stay productive. Using the Yeoman SharePoint generator, developers are able to scaffold new client-side solution projects to build, package, and deploy SharePoint solutions. The generator provides common build tools, boilerplate code, and a common playground website to host web parts for testing.
6
11
7
-
Yeoman SharePoint generator is available as part of the framework as a [npm package](https://www.npmjs.com/package/@microsoft/generator-sharepoint). You can install the generator by executing the following command in a console:
12
+
## Install the Yeoman SharePoint generator
13
+
14
+
Yeoman SharePoint generator is available as part of the framework as an [npm package](https://www.npmjs.com/package/@microsoft/generator-sharepoint). You can install the generator by executing the following command in a console:
8
15
9
16
```
10
17
npm install @microsoft/generator-sharepoint -g
11
18
```
12
19
13
20
> [!NOTE]
14
-
> Yeoman generator for SharePoint is targeted to get deployed globally with the initial General Availability (GA) version. There are some known issues if it's installed locally to the project, which are planned to be addressed postGA.
21
+
> The Yeoman SharePoint generator is targeted to get deployed globally with the initial General Availability (GA) version. There are some known issues if it's installed locally to the project, which are planned to be addressed post-GA.
15
22
16
-
It is recommended you follow the [set up your development environment](../set-up-your-development-environment.md) to configure your machine with the complete set of developer tools, including yeoman SharePoint generator.
23
+
We recommend that you follow the [set up your development environment](../set-up-your-development-environment.md)instructions to configure your machine with the complete set of developer tools, including Yeoman SharePoint generator.
17
24
18
-
## Using the yeoman SharePoint generator
25
+
## Use the Yeoman SharePoint generator
19
26
20
-
Once the generator is installed, you can invoke the generator by just typing the following command in a console:
27
+
After the generator is installed, you can invoke the generator by just typing the following command in a console:
21
28
22
29
```
23
30
yo
24
31
```
25
32
26
-
The command will list all of the generators available in your machine. Select the `@microsoft/sharepoint` to invoke the SharePoint generator and continue with the prompts to successfully create your client-side solution:
33
+
The command lists all the generators available on your machine. Select `@microsoft/sharepoint` to invoke the SharePoint generator and continue with the prompts to successfully create your client-side solution:
## Available command line options for the generator
38
+
## Use available command-line options for the generator
31
39
32
-
You can use the commandline options available with the yeoman SharePoint generator to scaffold projects in one command instead of going through the prompts. Execute the following command to see the list of commandline options available for the SharePoint generator:
40
+
You can use the command-line options available with the Yeoman SharePoint generator to scaffold projects in one command instead of going through the prompts. Execute the following command to see the list of command-line options available for the SharePoint generator:
33
41
34
42
```
35
43
yo @microsoft/generator-sharepoint --help
36
44
```
37
45
38
-
46
+
<br/>
47
+
48
+
49
+
50
+
<br/>
51
+
52
+
**Command-line options**
39
53
40
54
Option | Description
41
55
-----|------
42
56
--help|Print the generator's options and usage.
43
57
--skip-cache|Do not remember prompt answers. Default: *false*.
44
58
--skip-install|Do not automatically install dependencies. Default: *false*.
45
-
--componentType|The type of component. Currently "webpart" or "extension" is supported
59
+
--componentType|The type of component. Currently "webpart" or "extension" is supported.
46
60
--componentDescription|Description of the component.
47
61
--componentName|Name of the component.
48
62
--framework|Framework to use for the solution. Choose one from "none", "react", "knockout".
49
-
--extensionType|The type of extension: Currently "ApplicationCustomizer", "FieldCustomizer", "ListViewCommandSet"
63
+
--extensionType|The type of extension: Currently ApplicationCustomizer, FieldCustomizer, ListViewCommandSet.
50
64
--solutionName|Client-side solution name, as well as folder name.
51
65
--environment|The target environment for the solution. Either "onprem" or "spo".
52
66
53
-
Following table lists the available arguments.
67
+
<br/>
68
+
69
+
**Available arguments**
54
70
55
71
Argument | Description | Type | Required |
56
72
-- | -- | -- | -- |
57
73
skipFeatureDeployment | If specified, allow the tenant admin the choice of being able to deploy the components to all sites immediately without running any feature deployment or adding apps in sites. | Boolean | false |
58
74
59
-
Below is an example of a command that creates a solution called "hello-world" with a web part "HelloWorld" with "react" framework targeted only to SharePoint Online with tenant-scoped deployment optional enabled:
75
+
<br/>
76
+
77
+
Following is an example of a command that creates a solution called "hello-world" with:
78
+
- A web part "HelloWorld"
79
+
- The "react" framework targeted only to SharePoint Online
80
+
- Tenant-scoped deployment optional enabled
81
+
82
+
Notice that some of the options have dependencies between each other. You cannot, for example, create an extension with an on-premises option.
60
83
61
84
```
62
-
yo @microsoft/sharepoint --solutionName "hello-world" --framework "react" --componentType "webpart" --componentName "HelloWorld" --componentDescription "HelloWorld web part" --skip-install --environment "spo" skipFeatureDeployment true
85
+
yo @microsoft/sharepoint
86
+
--solutionName "hello-world"
87
+
--framework "react"
88
+
--componentType "webpart"
89
+
--componentName "HelloWorld"
90
+
--componentDescription "HelloWorld web part"
91
+
--skip-install
92
+
--environment "spo" skipFeatureDeployment true
63
93
```
64
94
65
-
> Notice that some of the options have dependencies between each other. You cannot for example create extension with on-premises option.
95
+
<br/>
66
96
67
97
> [!NOTE]
68
-
> Using the `--skip-install` command will scaffold the project and skip installing dependencies. This means, to successfully build the project, you will need to install the dependencies later once the project is scaffolded.
98
+
> Using the `--skip-install` command scaffolds the project and skips installing dependencies. This means that to successfully build the project, you need to install the dependencies later after the project is scaffolded.
69
99
70
-
> If you try to build your project without installing the dependencies, then you will get the following error. This indicates you need to install the dependencies before building the project:
100
+
> If you try to build your project without installing the dependencies, you get the following error. This indicates that you need to install the dependencies before building the project:
0 commit comments