Skip to content

Commit 50d376c

Browse files
committed
Add-in transformation guidance
1 parent df3731b commit 50d376c

File tree

4 files changed

+71
-30
lines changed

4 files changed

+71
-30
lines changed
Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,53 @@
11
---
22
title: Modernizing your SharePoint add-in model implementations in Microsoft 365
33
description:
4-
ms.date: 08/28/2023
4+
ms.date: 09/12/2023
55
ms.prod: sharepoint
66
ms.localizationpriority: high
7-
---
7+
---
8+
9+
# Modernization guidance for existing SharePoint add-in model implementations in Microsoft 365
10+
11+
SharePoint add-in model was introduced as part of the SharePoint 2013 timeframe and it was also provided as an extensibility option for SharePoint Online (Microsoft 365). While SharePoint add-in model is currently still supported in the SharePoint Online, model and patterns and outdated and are not recommended to be used.
12+
13+
Microsoft is looking into officially deprecating SharePoint add-in model in autumn 2023 - spring 2024 timeframe with clear communications on the detailed end-of-life schedule for related features.
14+
15+
> [!IMPORTANT]
16+
> Deprecation means official statement that the feature is no longer being invested, but it's stil supported. End-of-life means that the feature will be discontinued and is no longer available for use.
17+
18+
These upcoming changes will be impacting SharePoint add-in model and also authentication patterns using the classic [SharePoint Online hosted Microsoft Azure Access Control Service](https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins) (ACS) authentication patterns, used with the provided hosted add-ins and potentially with other unattended services connecting to SharePoint Online.
19+
20+
## Transformation technologies
21+
22+
Here's a high level table of the feature mapping as the add-in model implementation is transformed to use other long term supported features:
23+
24+
25+
26+
## Transformation guidance for the add-in techniques
27+
28+
Here's a list of all articles for the transformation guidance when moving away on using SharePoint add-in model, grouped based on the covered topic:
29+
30+
31+
* Modern Provisioning
32+
* [Modern provisioning of artifacts and Information Architecture](./Modern-Provisioning.md)
33+
* Modern Authentication and Authorization
34+
* [Understanding Azure Active Directory and OAuth 2.0 in the context of SharePoint Online modern development](./Understanding-AAD-and-OAuth-for-SPO-modern.md)
35+
* [From Access Control Service applications to Azure Active Directory applications](./From-ACS-to-AAD-apps.md)
36+
* [Building Multi-tenant applications for SharePoint Online](./Multi-tenant-applications.md)
37+
* [Understanding Resource Specific Consent (RSC)](./Understanding-RSC-for-MSGraph-and-SharePoint-Online.md)
38+
* Customizing the modern UI
39+
* [From App Parts and classic Web Parts to modern client-side SPFx Web Parts](./From-App-Parts-to-Modern-Web-Parts.md)
40+
* [From UI Extensions to SPFx List View Command Set](./From-UI-Extensions-to-ListView-Command-Sets.md)
41+
* [From status bars and notifications to SPFx Application Customizers](./From-Notifications-to-Application-Customizers.md)
42+
* [From classic dialogs to modern dialogs with SharePoint Framework](./From-classic-Dialogs-to-modern-Dialogs.md)
43+
* Building modern SharePoint Online or Microsoft 365 solutions
44+
* [From SharePoint JavaScript Object Model to Client-side code and PnPjs](./From-JSOM-to-Client-Side.md)
45+
* [From Client Side Object Model (CSOM) to PnP Framework and PnP Core SDK](./From-CSOM-to-PnP-Libraries.md)
46+
* [From XSLT rendering to List Formatting](./From-XSLT-to-List-Formatting.md)
47+
* [From Remote Event Receivers to SharePoint Online Webhooks and Microsoft Graph Webhooks](./From-Remote-Event-Receivers-to-Webhooks.md)
48+
* [From SharePoint-hosted apps to client-side applications](./From-SharePoint-Hosted-to-Client-Side.md)
49+
* [From provider-hosted apps to AAD applications](./From-Provider-Hosted-to-AAD-applications.md)
50+
* [From SharePoint Add-in model Workflow Apps to Microsoft Power Automate](./From-Workflow-Apps-to-Power-Automate.md)
51+
* [Publishing modern SharePoint applications on Microsoft AppSource](./Publishing-modern-SharePoint-apps-on-AppSource.md)
52+
53+
If some essential guidance is not included, please open an issue at the SharePoint developer documentation and we will try to help you as fast as possible with your specific question.

docs/spfx/compatibility.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The following table lists SharePoint Framework and compatible versions of common
3434

3535
| SPFx | Node.js (LTS) | NPM | TypeScript | React |
3636
| ------------------------------- | --------------- | ----------------------------------------- | -------------- | ----------- |
37+
| [1.18](release-1.18.md) | v16, v18 | v5, v6, v7, v8, v9 | v4.5, v4.7 | v17.0.1 |
3738
| [1.17.4](release-1.17.4.md) | v16.13+ | v5, v6, v7, v8 | v4.5 | v17.0.1 |
3839
| [1.17.3](release-1.17.3.md) | v16.13+ | v5, v6, v7, v8 | v4.5 | v17.0.1 |
3940
| [1.17.2](release-1.17.2.md) | v16.13+ | v5, v6, v7, v8 | v4.5 | v17.0.1 |

docs/spfx/release-1.18.md

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
11
---
2-
title: SharePoint Framework v1.18 preview release notes
3-
description: Release notes for the SharePoint Framework v1.18 preview release
4-
ms.date: 08/30/2023
2+
title: SharePoint Framework v1.18 release notes
3+
description: Release notes for the SharePoint Framework v1.18 release
4+
ms.date: 09/12/2023
55
ms.localizationpriority: high
66
---
7-
# SharePoint Framework v1.18 preview release notes
7+
# SharePoint Framework v1.18 release notes
88

99
This release focuses on new features within the Viva Connections side and evolving existing capabilities within the other areas on building Microsoft 365 solutions with SharePoint Framework.
1010

11-
[!INCLUDE [spfx-release-beta](../../includes/snippets/spfx-release-beta.md)]
12-
13-
- rc.1 **Released**: August 30, 2023
14-
- beta.5 **Released**: August 15, 2023
15-
- beta.3 **Released**: August 1, 2023
16-
- beta.2 **Released**: July 18, 2023
17-
- beta.1 **Released**: June 28, 2023
11+
**Released:** September 12, 2023
1812

1913
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
2014

2115
## Install the preview latest version
2216

23-
Install the latest preview release of the SharePoint Framework (SPFx) by using the **@next** tag
17+
Install the latest official release of the SharePoint Framework (SPFx) by using the **@latest** tag
2418

2519
```console
26-
npm install @microsoft/generator-sharepoint@next --global
20+
npm install @microsoft/generator-sharepoint@latest --global
2721
```
2822

2923
## Upgrading projects from v1.17 to v1.18
@@ -39,7 +33,7 @@ In the project's **package.json** file, identify all SPFx v1.17.x packages. For
3933
1. Install the new v1.18 package:
4034

4135
```console
42-
npm install @microsoft/{spfx-package-name}@next --save --save-exact
36+
npm install @microsoft/{spfx-package-name}@latest --save --save-exact
4337
```
4438

4539
[!INCLUDE [spfx-release-upgrade-tip](../../includes/snippets/spfx-release-upgrade-tip.md)]
@@ -48,20 +42,24 @@ In the project's **package.json** file, identify all SPFx v1.17.x packages. For
4842

4943
Related updated documentation for the 1.18 preview release:
5044

51-
* [Designing Viva Connections custom cards for your dashboard](./viva//design//designing-card.md)
45+
* [Designing Viva Connections custom cards for your dashboard](./viva/design//designing-card.md)
5246
* [Migrate Adaptive Card Extensions to SharePoint Framework 1.18](./viva/get-started/migrate-to-spfx-1-18.md)
5347
* [Tutorial - Create a People Search Adaptive Card Extension](./viva/get-started//build-people-search-adaptive-card-extension.md)
5448

5549
New samples showcasing the new Viva Connections features:
5650

57-
* [Start a Chat Text Box input Adaptive Card Extention](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/InputCard-Start-Chat)
51+
* [Start a Chat Text Box input Adaptive Card Extension](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/InputCard-Start-Chat)
5852
* [Prompt Survey Adaptive Card Extension](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/InputCard-Prompt-Survey)
5953
* [People Search Adaptive Card Extension](https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/InputCard-PeopleSearch)
6054

6155
Video in YouTube showcasing the new template options for Viva Connections
6256

6357
* [Introducing new Microsoft Viva Connection card layouts in the SharePoint Framework 1.18](https://www.youtube.com/watch?v=S5KCV3ZiAAI)
6458

59+
### NodeJS v18 support
60+
61+
SharePoint Framework solutions now support NodeJS v18 as the default version.
62+
6563
### Support for Execute Action in Adaptive Card Extensions
6664

6765
Developers can use `Execute` action for both card view and quick view actions.
@@ -156,7 +154,7 @@ onChange?: (newValue?: string) => void;
156154
157155
### Ability to detect host's theme for Viva Connections Mobile
158156

159-
Starting with this version developers have access to `hostContext` in the `AdaptiveCardExtensionContext` object. This property allows to detect host's theme.
157+
Starting with this version, developers have access to `hostContext` in the `AdaptiveCardExtensionContext` object. This property allows to detect host's theme.
160158
```typescript
161159

162160
export type HostTheme = 'light' | 'dark' | undefined;
@@ -174,36 +172,31 @@ export interface IHostContext {
174172

175173
### Fluent UI React v8 support
176174

177-
Starting this version React templates use Fluent UI React v8 instead of v7.
175+
Starting from this version, React templates use Fluent UI React v8 instead of v7.
178176

179177
### Transparent outline icon for Teams-hosted web parts
180178

181-
The default outline icon for Teams-hosted web parts is now transparent. This allows to meet the Teams design guidelines for application.
179+
The default outline icon for Microsoft Teams hosted web parts is now transparent. This ensures that the default icon meets the Microsoft Teams design requirements for application.
182180

183181
### TypeScript v4.7 Support
184182

185183
SPFx solutions now support TypeScript v4.7.
186184

187-
### NodeJS v18 support
188-
189-
SPFx solutions now support NodeJS v18.
190-
191185
> [!NOTE]
192186
> A developer needs to manually set NODE_OPTIONS environment variable to `--openssl-legacy-provider` to use NodeJS v18 after the NodeJS 18 has been installed. This requirement is intended to be removed with the General Availability version of the 1.18. This setting is required to adjust the toolchain to work properly with Webpack 4 which the SPFx tooling is using for now.
193187
> This can be done using `export NODE_OPTIONS=--openssl-legacy-provider` on Mac/Linux or `set NODE_OPTIONS=--openssl-legacy-provider` on Windows.
194188
195-
196189
## Deprecations
197190

198191
- `BaseAdaptiveCardView` - use `BaseAdaptiveCardQuickView` instead
199192
- `template` property in `BaseTemplateCardView` and its descendants
200193

201194
## Fixed Issues
202195

203-
- [#9010](https://github.com/SharePoint/sp-dev-docs/issues/9010) - Placeholder `{tenantDomain}` is not replaced with `SPFX_SERVE_TENANT_DOMAIN`.
196+
- [#9010](https://github.com/SharePoint/sp-dev-docs/issues/9010) - Placeholder `{tenantDomain}` isn't replaced with `SPFX_SERVE_TENANT_DOMAIN`.
204197

205198
## Feedback and issues
206199

207-
We are interested on your feedback around the release. Please do let us know any findings or other feedback using the [SPFx issue list](https://github.com/SharePoint/sp-dev-docs/issues).
200+
We're interested on your feedback around the release. Do let us know any findings or other feedback using the [SPFx issue list](https://github.com/SharePoint/sp-dev-docs/issues).
208201

209202
Happy coding! Sharing is caring! 🧡

docs/spfx/set-up-your-development-environment.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can also follow these steps by watching this video on the Microsoft 365 Plat
2121
2222
## Install Node.js
2323

24-
Install the most recent LTS version of **[Node.js](https://www.nodejs.org) v16**.
24+
Install the most recent LTS version of **[Node.js](https://www.nodejs.org) v18**.
2525

2626
This version is the currently recommended version of Node.js to use with the SharePoint Framework (*unless otherwise specified below*).
2727

@@ -42,8 +42,9 @@ You can check if you already have Node.js already installed, including installed
4242
node --version
4343
```
4444

45-
The SharePoint Framework v1.17.* is supported on the following Node.js versions:
45+
The SharePoint Framework v1.18.* is supported on the following Node.js versions:
4646

47+
- Node.js v18 LTS (*aka: Hydrogen*)
4748
- Node.js v16 LTS (*aka: Gallium*)
4849

4950
> [!CAUTION]

0 commit comments

Comments
 (0)