Skip to content

Commit 2fcda8e

Browse files
docs(spfx): πŸ“ deprecate online workbench (#10816)
* docs(spfx): πŸ“ deprecate online workbench - add reusable snippet for online workbench deprecation - include snippet in debug-in-vscode & hello-world articles - note deprecation in v1.23 release notes - tighten wording & v1.23 references in release notes - align ms.date with original upstream commit per file * Update spfx-online-workbench-deprecation.md --------- Co-authored-by: Vesa Juvonen <VesaJuvonen@users.noreply.github.com>
1 parent 3a31faa commit 2fcda8e

4 files changed

Lines changed: 16 additions & 10 deletions

File tree

β€Ždocs/spfx/debug-in-vscode.mdβ€Ž

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debug SharePoint Framework solutions in Visual Studio Code
33
description: Prerequisites and steps for configuring Visual Studio Code for debugging SharePoint Framework solutions.
4-
ms.date: 02/24/2026
4+
ms.date: 04/21/2017
55
ms.localizationpriority: high
66
---
77
# Debug SharePoint Framework solutions in Visual Studio Code
@@ -52,7 +52,9 @@ The debug mode in Visual Studio Code starts, changing the color of the status ba
5252
To verify that debugging is working, in the workbench, add your web part to the canvas.
5353

5454
> [!IMPORTANT]
55-
> The local workbench (`https://localhost:4321/temp/workbench.html`) was **removed in SPFx v1.13** and will not work. Use the hosted workbench (`/_layouts/workbench.aspx`) or debug directly on a modern SharePoint page instead.
55+
> The local workbench (`https://localhost:4321/temp/workbench.html`) was **removed in SPFx v1.13** and will not work.
56+
57+
[!INCLUDE [spfx-online-workbench-deprecation](../../includes/snippets/spfx-online-workbench-deprecation.md)]
5658

5759
![Web part toolbox open in SharePoint workbench](../images/vscode-debugging-adding-web-part-to-canvas.png)
5860

@@ -154,7 +156,7 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
154156
}}
155157
```
156158

157-
1. Select **Load debug scripts** to continue loading scripts from your local host.
159+
1. Select **Load debug scripts** to continue loading scripts from your localhost.
158160

159161
![Allow Debug Manifest question from the page](../images/ext-app-debug-manifest-message.png)
160162

β€Ždocs/spfx/release-1.23.mdβ€Ž

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you are upgrading from older than 1.22 version, please follow the upgrade ste
2828

2929
### Grouping support for list view command sets
3030

31-
Starting with the SPFx 1.23, we will be also supporting grouping of list view command sets in the toolbar and in the context menu. This provides more control on how the list view commands are rendered in lists and libraries.
31+
Starting with the SPFx v1.23, we will be also supporting grouping of list view command sets in the toolbar and in the context menu. This provides more control on how the list view commands are rendered in lists and libraries.
3232

3333
![Card personalization visible in the dashboard UI](../images/123-release/list-view-cmdset-grouping.png)
3434

@@ -67,12 +67,11 @@ Your feedback is welcome. Let us know your first impressions and provide suggest
6767

6868
### Addressing npm audit issues
6969

70-
When installing the SharePoint Framework Yeoman generator or scaffolding solutions, we have worked addressing all reported `npm audit` issues. Addressing vulnerabilities is a moving target, which we keep on addressing with all releases.
70+
When installing the SharePoint Framework Yeoman generator or scaffolding solutions, we have worked on the reported `npm audit` issues. Addressing vulnerabilities is a moving target, which we keep on addressing with all releases.
7171

7272
## Deprecations
7373

74-
- SharePoint Framework Online Workbench will be retired from SharePoint Online on 1st of December 2026
75-
- We encourage to use the [debugging toolbar](./debug-toolbar.md) and do testing and validation of your code on normal SharePoint pages.
74+
- **Hosted workbench is deprecated** - This is the last release that will include support for the SharePoint Framework online workbench; the hosted workbench will be retired on December 1, 2026. The recommended replacement is to use the [SharePoint Framework Debug Toolbar](../../docs/spfx/debug-toolbar.md)
7675
- [Geolocation feature](./viva/get-started/actions/geolocation/geolocationdocumentation) is deprecated in the context of Adaptive Card Extensions (ACEs) with full retirement from SharePoint Online on 1st of December 2026
7776

7877
## Feedback and issues

β€Ždocs/spfx/web-parts/get-started/build-a-hello-world-web-part.mdβ€Ž

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first SharePoint client-side web part (Hello World part 1)
33
description: Create a new web part project and preview it.
4-
ms.date: 12/18/2025
4+
ms.date: 08/26/2016
55
ms.localizationpriority: high
66
ms.custom: scenarios:getting-started
77
---
@@ -90,7 +90,7 @@ Assuming you've installed & trusted developer certificate, execute the following
9090
heft start
9191
```
9292

93-
This command runs a series of Heft tasks to create and start a local webserver hosting the endpoints **localhost:4321** and **localhost:5432**. It will then open your default browser and load the hosted workbench preview web parts from your local dev environment.
93+
This command runs a series of Heft tasks to create and start a local webserver hosting the endpoints **localhost:4321** and **localhost:5432**. It will then open your default browser and load the hosted workbench preview web parts from your local dev environment:
9494

9595
```console
9696
<i> [webpack-dev-server] Project is running at:
@@ -110,6 +110,8 @@ Cancelling incremental build...
110110
webpack 5.95.0 compiled successfully in 41820 ms
111111
```
112112

113+
[!INCLUDE [spfx-online-workbench-deprecation](../../../../includes/snippets/spfx-online-workbench-deprecation.md)]
114+
113115
SharePoint client-side development tools use [Heft](https://heft.rushstack.io/) as the task runner to handle build process tasks such as:
114116

115117
- Transpile TypeScript files to JavaScript.
@@ -395,4 +397,3 @@ heft start
395397
Congratulations on getting your first Hello World web part running!
396398

397399
Now that your web part is running, you can continue building out your Hello World web part in the next topic, [Connect your web part to SharePoint](./connect-to-sharepoint.md). You will use the same Hello World web part project and add the ability to interact with SharePoint List REST APIs. Notice that the **Heft start** command is still running in your console window (or in Visual Studio Code if you're using that as editor). You can continue to let it run while you go to the next article.
398-
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> [!IMPORTANT]
2+
> The SharePoint Framework Online workbench is deprecated starting on May 13, 2026 and will be retired on December 1, 2026.
3+
>
4+
> The recommended replacement is to use the [SharePoint Framework Debug Toolbar](../../docs/spfx/debug-toolbar.md)

0 commit comments

Comments
Β (0)