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
Copy file name to clipboardExpand all lines: docs/spfx/sharepoint-framework-overview.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -8,33 +8,33 @@ Key features of the SharePoint Framework include:
8
8
* The controls are rendered in the normal page DOM.
9
9
* The controls are responsive and accessible by nature.
10
10
* Enables the developer to access the lifecycle - including, in addition to **render** - **load**, **serialize** and **deserialize**, **configuration changes**, and more.
11
-
* It's framework agnostic. You can use any browser framework that you like: React, Handlebars, Knockout, Angular, and more.
11
+
* It's framework agnostic. You can use any JavaScript framework that you like: React, Handlebars, Knockout, Angular, and more.
12
12
* The toolchain is based on common open source client development tools like npm, TypeScript, Yeoman, webpack, and gulp.
13
13
* Performance is reliable.
14
14
* End users can use SPFx client-side solutions that are approved by the tenant administrators (or their delegates) on all sites, including self-service team, group, or personal sites.
15
-
*Solutions can be deployed in both classic web part and publishing pages and modern pages.
15
+
*SPFx web parts can be added to both classic and modern pages.
16
16
17
-
The runtime model improves on the script editor web part. It includes a robust client API, an HttpClient object that handles authentication to SharePoint and Office 365, contextual information, easy property definition and configuration, and more.
17
+
The runtime model improves on the Script Editor web part. It includes a robust client API, an HttpClient object that handles authentication to SharePoint and Office 365, contextual information, easy property definition and configuration, and more.
18
18
19
-
If you work with C# and Visual Studio, or JavaScript, you might have to learn a little bit about client-side JavaScript development. Most of your knowledge is completely transferable. You’ll use the same [REST services](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) or [JavaScript Object Model (JSOM)](https://msdn.microsoft.com/en-us/library/office/jj193034.aspx) depending on your requirements. The data model has not changed in any way. And if you are a C# developer, TypeScript is a nice transition into the JavaScript world. The choice of IDE is up to you. Many developers like to use the cross-platform IDE Visual Studio Code. Many developers also use products like Sublime and ATOM. Use what works best for you.
19
+
If you work primarily with C#, you'll want to learn more about client-side JavaScript development. Most of your existing JavaScript knowledge related to SharePoint, however, is completely transferable, as the data models have not changed, and you’ll use the same [REST services](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) or [JavaScript Object Model (JSOM)](https://msdn.microsoft.com/en-us/library/office/jj193034.aspx), depending on your requirements. If you are a C# developer, TypeScript is a nice transition into the JavaScript world. The choice of IDE is up to you. Many developers like to use the cross-platform IDE Visual Studio Code. Many developers also use products like Sublime and ATOM. Use what works best for you.
20
20
21
21
## Why the SharePoint Framework?
22
22
23
-
SharePoint was launched as an on-premises product in 2001. Over time, a large developer community has extended and shaped it in many ways. For the most part, the developer community followed the same patterns and practices that the SharePoint product development team used, including web parts, SharePoint feature XML, and more. Many features were written in C#, compiled to DLLs, and deployed to the servers.
23
+
SharePoint was launched as an on-premises product in 2001. Over time, a large developer community has extended and shaped it in many ways. For the most part, the developer community followed the same patterns and practices that the SharePoint product development team used, including web parts, SharePoint feature XML, and more. Many features were written in C#, compiled to DLLs, and deployed to on-premises farms.
24
24
25
-
That solution worked well in environments with only one enterprise, but it didn’t scale to the cloud, where multiple tenants run side-by-side. As a result, we introduced two alternative models: client-side JavaScript injection, and SharePoint Add-ins. Both of these solutions have pros and cons.
25
+
That architecture worked well in environments with only one enterprise, but it didn’t scale to the cloud, where multiple tenants run side-by-side. As a result, we introduced two alternative models: client-side JavaScript injection, and SharePoint Add-ins. Both of these solutions have pros and cons.
26
26
27
27
### JavaScript injection
28
28
29
-
One of the most popular web parts in SharePoint Online is the Script Editor. You can use the Script Editor to paste JavaScript into the web part and have that JavaScript execute when the page renders. It’s simple and rudimentary, but effective. It runs in the same browser context as the page, and is in the same DOM, so it can interact with other controls on the page. It is also relatively performant, and simple to use.
29
+
One of the most popular web parts in SharePoint Online is the Script Editor. You can paste JavaScript into the Script Editor web part and have that JavaScript execute when the page renders. It’s simple and rudimentary, but effective. It runs in the same browser context as the page, and is in the same DOM, so it can interact with other controls on the page. It is also relatively performant, and simple to use.
30
30
31
-
There are a couple of downsides to this approach, however. First, while you can package your solution so that end users can drop the control onto the page, you can't easily provide configuration options. Also, the end user can edit the page and modify the script, which can break the web part. Another big problem is that the script editor web part is not marked as **"Safe For Scripting"**. Most self-service site collections (my-sites, team sites, group sites) have a feature known as **"NoScript"** enabled. Technically, it is the removal of the Add/Customize Pages (ACP) permission in SharePoint. This means that the script editor web part will be blocked from executing on these sites.
31
+
There are a couple of downsides to this approach, however. First, while you can package your solution so that end users can drop the control onto the page, you can't easily provide configuration options. Also, the end user can edit the page and modify the script, which can break the web part. Another big problem is that the Script Editor web part is not marked as **"Safe For Scripting"**. Most self-service site collections (my-sites, team sites, group sites) have a feature known as **"NoScript"** enabled. Technically, it is the removal of the Add/Customize Pages (ACP) permission in SharePoint. This means that the Script Editor web part will be blocked from executing on these sites.
32
32
33
33
### SharePoint Add-in model
34
34
35
35
The current option for solutions that run in NoScript sites is the add-in/app-part model. This implementation creates an **iFrame** where the actual experience resides and executes. The advantage is that because it's external to the system and has no access to the current DOM/connection, it's easier for information workers to trust and deploy. End users can install add-ins on NoScript sites.
36
36
37
-
There are a some downsides to this approach as well. First, they run in an **iFrame**. iFrames are slower than the script editor web part, because it requires a new request to another page. The page has to go through authentication and authorization, make its own calls to get SharePoint data, load various JavaScript libraries, and more. A script editor might typically take, for example, 100 milliseconds to load and render while an app-part might take 2 seconds or more. Additionally, the **iFrame** boundary makes it more difficult to create responsive designs, and inherit CSS and theming information. iFrames do have stronger security, which can be useful for you (your page is inaccessible by other controls on the page) and for the end user (the control has no access to their connection to Office 365).
37
+
There are a some downsides to this approach as well. First, they run in an **iFrame**. iFrames are slower than the script editor web part, because it requires a new request to another page. The page has to go through authentication and authorization, make its own calls to get SharePoint data, load various JavaScript libraries, and more. A Script Editor web part might typically take, for example, 100 milliseconds to load and render, while an apppart might take 2 seconds or more. Additionally, the **iFrame** boundary makes it more difficult to create responsive designs, and inherit CSS and theming information. iFrames do have stronger security, which can be useful for you (your page is inaccessible by other controls on the page) and for the end user (the control has no access to their connection to Office 365).
38
38
39
39
40
40
### SharePoint Framework
@@ -43,7 +43,7 @@ Historically, we created web parts as full trust C# assemblies that were install
43
43
44
44
## What's next?
45
45
46
-
This is the first preview release. We will provide updates and refinements over time based on your feedback and experiences. While the SharePoint Framework is in preview, you might experience occasional breaking changes around API names, flows, and more. Future updates to the SharePoint Framework will be backward compatible, so that your solutions will continue to work.
46
+
SharePoint Framework web parts have now reached General Availability (GA). We will continue to provide updates and refinements over time based on your feedback and experiences. For any additional SharePoint Framework capabilities that are first launched in preview mode, you might experience occasional breaking changes around API names, flows, and more. Future updates to the SharePoint Framework will be backward compatible, so that your solutions will continue to work.
0 commit comments