Skip to content

Commit 5b05c56

Browse files
andrewconnellandrewconnell
authored
Update SPFx docs to refresh roadmap & add release notes (SharePoint#5998)
* add spfx releases * Fix build report errors * Update TOC item links
1 parent a8a933c commit 5b05c56

18 files changed

+1243
-48
lines changed

‎docs/spfx/release-0.0.0.md.template

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: SharePoint Framework vTODO: {version-release} release notes
3+
description: Release notes for the SharePoint Framework vTODO: {version-release} release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework vTODO: {version-release} release notes
9+
10+
TODO:
11+
12+
**Released:** TODO: {release-date}
13+
14+
## Upgrading projects from vTODO: {version-previous} to vTODO: {version-release}
15+
16+
1. In the project's **package.json** file, identify all SPFx vTODO: {version-previous} packages. For each SPFx package:
17+
1. Uninstall the existing vTODO: {version-previous} package:
18+
19+
```console
20+
npm uninstall @microsoft/{spfx-package-name}@TODO: {version-previous}
21+
```
22+
23+
1. Install the refreshed vTODO: {version-release} package:
24+
25+
```console
26+
npm install @microsoft/{spfx-package-name}@TODO: {version-release}.0 --save --save-exact
27+
```
28+
29+
> [!TIP]
30+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
31+
32+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
33+
34+
## New features and capabilities
35+
36+
TODO:
37+
38+
## Changes in this release
39+
40+
TODO:
41+
42+
## Deprecations and removed items in this release
43+
44+
TODO:

‎docs/spfx/release-1.0.0.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: SharePoint Framework v1.0.0 release notes
3+
description: Release notes for the SharePoint Framework v1.0.0 release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.0.0 release notes
9+
10+
Welcome to the General Availability of SPFx 1.0. It's been an exciting and interesting trip so far, and will continue to be. This is only the first release - expect a steady stream of improvements and features.
11+
12+
**Released:** February 22, 2017
13+
14+
## Upgrading projects from preview versions to v1.0.0
15+
16+
1. In the project's **package.json** file, identify all SPFx pre-v1 packages. For each SPFx package:
17+
1. Uninstall the existing pre-v1 package:
18+
19+
```console
20+
npm uninstall @microsoft/{spfx-package-name}
21+
```
22+
23+
1. Install the refreshed v1.0.0 package:
24+
25+
```console
26+
npm install @microsoft/{spfx-package-name}@1.0.0.0 --save --save-exact
27+
```
28+
29+
> [!TIP]
30+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
31+
32+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
33+
34+
## New features and capabilities
35+
36+
You can get the updated npm packages and use them in the local workbench, and everything should be fine. However, the rollout of the code to the servers will be done in stages over the course of several days. By sometime next week 100% of the farms should have it. We do this to monitor the rollout and make sure we don't have any issues.
37+
38+
### Will I get to use SPFX and client side web parts now?
39+
40+
There are really two different things at play. One is the code being available on all the farms, the second is the feature being enabled for a given tenant.
41+
42+
Similar to how the code rolls out across the farms, the feature will be rolled out to tenants. We'll start with the same first-release tenants (not users, tenants) that have SPFX today. Over the course of a couple of weeks, it should roll to all tenants.
43+
44+
You'll know if it has reached a given tenant because uploading the package into the app catalog will say it's valid. Even tenants that can't upload packages can still try out SPFx, they'll just be limited to the local and hosted workbench (found at **_layouts/15/workbench.aspx**).
45+
46+
## Changes in this release
47+
48+
- There are only a few changes in the actual SharePoint Framework code. The bulk of our work between RC0 and GA had to do with stability and future-proofing. It is our explicit goal that the parts you create today should continue to work for years to come. But fixes made to the underlying service continue to be supplied without issues, we don't have 7 different minor and patch versions of framework code loaded, and so on. There's still some work to do in this area for some components - we'll get to those.
49+
- The biggest change to the code itself is that we incorporated the strict null checks flag into SPFX, meaning that you can also enable this flag in your projects. It changed the API slightly, but should only be noticed if you enable strict null checks yourself.
50+
- The other noticeable changes are in the default code that is generated by running the Yeoman generator. v1.0.0 is the version of the packages. We now reference **\@types/\*** with a strict version (no more lodash errors).
51+
- We have feature XML support (along with upgrade). This can be used to provision needed fields, content types and lists for the web part in “elevated” mode. We'll write up some posts on this in more detail.
52+
- We've finalized the serialization format on classic pages. You should delete and re-add your web parts. We'll support the old serialization format for a short while, then it will stop working.
53+
- `require('./config/docs.config.html');` now returns object in GA rather than string like RC0
54+
55+
## Known issues
56+
57+
We have temporarily removed **office-ui-fabric-react** from the react template until we can get the package moved to a future-proof form. We expect that to take a couple of weeks.

‎docs/spfx/release-1.1.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: SharePoint Framework v1.1 release notes
3+
description: Release notes for the SharePoint Framework v1.1 release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.1 release notes
9+
10+
This release introduces the developer preview of extensions.
11+
12+
**Released:** June 6, 2017
13+
14+
## Upgrading projects from v1.0 to v1.1
15+
16+
1. In the project's **package.json** file, identify all SPFx v1.0 packages. For each SPFx package:
17+
1. Uninstall the existing v1.0 package:
18+
19+
```console
20+
npm uninstall @microsoft/{spfx-package-name}@1.0
21+
```
22+
23+
1. Install the refreshed v1.1 package:
24+
25+
```console
26+
npm install @microsoft/{spfx-package-name}@1.1.0 --save --save-exact
27+
```
28+
29+
> [!TIP]
30+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
31+
32+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
33+
34+
## New features and capabilities
35+
36+
### SPFx Extensions (developer preview)
37+
38+
Welcome to the latest developer preview of SPFx. This time round we are tackling extending the modern SharePoint applications like the modern list/libraries and the modern team site pages.
39+
40+
- [Overview of SharePoint Framework Extensions](extensions/overview-extensions.md)
41+
42+
You can get the updated NPM packages now, but the solutions you build will only work on Developer Tenants - not site collections, but developer tenants.
43+
44+
This is the same process as the original developer preview drop of SPFx web parts. We expect to make some breaking changes before we hit GA, and want to ensure that solutions aren't rolled out to production tenants yet. Over the next while we will extend the preview to first release tenants (not users, but tenants) and then to all tenants.
45+
46+
### New packages
47+
48+
- **\@microsoft/sp-dialog**: An API to make it easy to create dialog boxes in your extensions (and web parts!).
49+
- **\@microsoft/sp-listview-extensibility**: List-specific extensions around fields and command sets.
50+
- **\@microsoft/sp-extension-base**: The system base classes for all extensions.
51+
- **\@microsoft/sp-application-base**: The base classes required for the application customizer extension type.

‎docs/spfx/release-1.10.0.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: SharePoint Framework v1.10 release notes
3+
description: Release notes for the SharePoint Framework v1.10 release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.10 release notes
9+
10+
New in this release, preview code for **Office Add-Ins** and a new Extension type **Search Extensions**. We also added support for personal apps in Microsoft Teams and Teams mobile support.
11+
12+
**Released:** January 7, 2020
13+
14+
## Upgrading projects from v1.9.1 to v1.10
15+
16+
1. In the project's **package.json** file, identify all SPFx v1.9.1 packages. For each SPFx package:
17+
1. Uninstall the existing v1.9.1 package:
18+
19+
```console
20+
npm uninstall @microsoft/{spfx-package-name}@1.9.1
21+
```
22+
23+
1. Install the refreshed v1.10 package:
24+
25+
```console
26+
npm install @microsoft/{spfx-package-name}@1.10.0 --save --save-exact
27+
```
28+
29+
> [!TIP]
30+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
31+
32+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
33+
34+
## New features and capabilities
35+
36+
- Create Office Add-Ins using SPFx web parts (dev preview)
37+
- [Docs: Create Outlook add-ins using SharePoint Framework](office-addins-create.md)
38+
- [Tutorial: Create Outlook Web Access extension using SharePoint Framework](web-parts/get-started/office-addins-tutorial.md)
39+
40+
> [!NOTE]
41+
> The Outlook Web Access support is being currently rolled out and can take until end of the release week (10th of January), before it's fully functional in your tenant
42+
43+
- Create Search Extensions (dev preview)
44+
- [Modifying Microsoft Search experience using SharePoint Framework extensions](building-search-extensions.md)
45+
- Create Teams Personal Apps (GA)
46+
- [Docs: Building Microsoft Teams Tabs using SharePoint Framework](integrate-with-teams-introduction.md)
47+
- [Tutorial: Build Microsoft Teams tab using SharePoint Framework](web-parts/get-started/using-web-part-as-ms-teams-tab.md)
48+
- Subscribing to list changes (GA)
49+
- [Subscribe to list notifications](subscribe-to-list-notifications.md)
50+
- Pre-allocate space for your Application customizer top / bottom placeholder
51+
- [Pre-allocate space for SharePoint Framework extension placeholders](extensions/basics/preallocated-space-placeholders.md)
52+
53+
## Changes in this release
54+
55+
- The default compiler for new projects is now **TypeScript v3.3**
56+
- We've migrated the SharePoint Online to **Office UI Fabric React 7**. The next release of SPFx will include support for third-party components. At the present time, you'll experience rendering issues if you try to use Office UI Fabric React and have a component that loads the legacy css (either because it was made with version < v1.8.2, or has the `UseLegacyCSS` flag set to true in the manifest).
57+
- We continue to improve the admin experience around approving API requests in the SharePoint ONline tenant admin UIs.
58+
59+
## Deprecations and removed items in this release
60+
61+
- We're moving towards using **require.js** for the loader, rather than **system.js**. This is already the loader used for extensions running in the list app. There shouldn't be a change for you. The next version of SPFx will use the **require.js** loader for the local workbench. The online workbench will migrate to **require.js** over the next month or two, but we'll have a query string override to help diagnose any issues with new code.
62+
- We'll be removing support for Node 8 in the next release. The goal is to also introduce support for Node 12 at that time.
63+
- We're deprecating the Knockout-based web part template from the Yeoman generator due to low usage. It will be fully removed with the v1.11 release
64+
- Accessing Microsoft Teams context using `this.context.microsoftTeams` property has been deprecated, you should be using `this.context.sdks.microsoftTeams` property instead.

‎docs/spfx/release-1.3.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: SharePoint Framework v1.3 release notes
3+
description: Release notes for the SharePoint Framework v1.3 release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.3 release notes
9+
10+
This release contains the general availability of extensions.
11+
12+
**Released:** September 25, 2017
13+
14+
## Upgrading projects from v1.1 to v1.3
15+
16+
1. In the project's **package.json** file, identify all SPFx v1.1 packages. For each SPFx package:
17+
1. Uninstall the existing v1.1 package:
18+
19+
```console
20+
npm uninstall @microsoft/{spfx-package-name}@1.1
21+
```
22+
23+
1. Install the refreshed v1.3 package:
24+
25+
```console
26+
npm install @microsoft/{spfx-package-name}@1.3.0 --save --save-exact
27+
```
28+
29+
> [!TIP]
30+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
31+
32+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
33+
34+
## New features and capabilities
35+
36+
### SharePoint Extensions (general availability)
37+
38+
- [Overview of SharePoint Framework Extensions](extensions/overview-extensions.md)

‎docs/spfx/release-1.4.1.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: SharePoint Framework v1.4.1 release notes
3+
description: Release notes for the SharePoint Framework v1.4.1 release
4+
ms.date: 07/03/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.4.1 release notes
9+
10+
**Released:** February 15, 2018
11+
12+
## Upgrading projects from v1.4 to v1.4.1
13+
14+
1. In the project's **package.json** file, identify all SPFx v1.4 packages. For each SPFx package:
15+
1. Uninstall the existing v1.4 package:
16+
17+
```console
18+
npm uninstall @microsoft/{spfx-package-name}@1.4
19+
```
20+
21+
1. Install the refreshed v1.4.1 package:
22+
23+
```console
24+
npm install @microsoft/{spfx-package-name}@1.4.1.0 --save --save-exact
25+
```
26+
27+
> [!TIP]
28+
> The [Office 365 CLI](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
29+
30+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
31+
32+
## New features and capabilities
33+
34+
### Node v8 (LTS) and NPM v5 Support
35+
36+
Support of Node.js v8 (LTS) and NPM v5 is now available in SPFx.
37+
38+
Issue reported here: https://github.com/SharePoint/sp-dev-docs/issues/1002
39+
40+
We've also updated the [Set up your SharePoint Framework development environment](set-up-your-development-environment.md) article.
41+
42+
### New APIs (developer preview)
43+
44+
Following are new APIs available for preview usage within SharePoint Online. These are **not** meant to be used in production yet.
45+
46+
#### @microsoft/sp-http
47+
48+
- Initial beta release of AadHttpClient class
49+
- Initial beta release of AadTokenProvider class
50+
51+
#### @microsoft/sp-client-preview
52+
53+
- Initial beta release of MSGraphClient class
54+
55+
You can find a tutorial for these new APIs from the Office SharePoint Development documentation.
56+
57+
- [Tutorial: Consume the Microsoft Graph in the SharePoint Framework](use-aad-tutorial.md)
58+
59+
### AadHttpClient (developer preview)
60+
61+
**AadHttpClient** is used to do REST calls against an Azure AD Application, for example third-party WebAPI hosted in Azure.
62+
63+
- For communicating with SharePoint, use the `SPHttpClient` class instead.
64+
- For communicating with Microsoft Graph, use the `MSGraphClient` class.
65+
66+
You can find more information on this new API from the Office SharePoint Development documentation:
67+
68+
- [Connect to Azure AD-secured APIs in SharePoint Framework solutions](use-aadhttpclient.md)
69+
70+
### MSGraphClient (developer preview)
71+
72+
`MSGraphClient` is used to do REST calls against Microsoft Graph. The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without needing to initialize the MSGraph client library.
73+
74+
If a custom configuration is wanted, the `MSGraphClient` API function needs to be provided with that custom configuration for every request.
75+
76+
- [Use the MSGraphClient to connect to Microsoft Graph](use-msgraph.md)
77+
78+
> [!IMPORTANT]
79+
> Notice that this API is replacing the previously released `GraphHttpClient`, which is now considered to be deprecated.
80+
81+
### AadTokenProvider
82+
83+
This class is an internal class used by AadHttpClient and MSGraphClient to obtain OAuth2 tokens from Azure AD. Although the class is currently marked as public, we're planning to change it as internal. For that reasons solutions should only rely on `AadHttpClient` and `MSGraphClient` classes.
84+
85+
## Changes in this release
86+
87+
- Fixed an issue in the generator that prevented activation of new versions of SPFx packages.
88+
- **Symptoms** - You deploy a new version of SharePoint Framework packages and you no longer see your web parts in web part picker.
89+
- [#775](https://github.com/SharePoint/sp-dev-docs/issues/775)
90+
- **Fix**: To fully successfully fix this issue, you'll need to do following steps in your SharePoint Online tenants.
91+
1. Remove all instances of existing SharePoint Framework solutions from site level
92+
1. Remove SharePoint Framework solution from app catalog
93+
1. Upload new SharePoint Framework solution built with 1.4.1 version to your app catalog
94+
1. Install SharePoint Framework solutions back to sites.
95+
96+
> [!NOTE]
97+
> This issue is **not** happening for tenant-scoped SharePoint Framework solutions and it's not happening for SharePoint add-ins.
98+
99+
> [!TIP]
100+
> You might potentially take advantage of the [Application Lifecycle Management (ALM) APIs](../apis/alm-api-for-spfx-add-ins.md) to automate this needed process.
101+
102+
## Deprecations and removed items in this release
103+
104+
- The `GraphHttpClient` API has been deprecated in favor of the new `MSGraphClient` introduced in this release. The `GraphHttpClient` will be removed in a future release.

0 commit comments

Comments
 (0)