Skip to content

Commit 0437af5

Browse files
Doc content update (#10741)
* Update publication date and SPFx version recommendation Updated the publication date and added a recommendation for using the latest SPFx version. * Revise documentation for list notifications subscription Updated the documentation for subscribing to list notifications, including prerequisites, usage examples, and additional configuration options. * Revise SharePoint Framework preview capabilities documentation Updated the date and refined the content regarding SharePoint Framework preview capabilities. * docs: improve content quality across SPFx articles - add trailing period to description metadata - add blank line between code block and alert in list notifications - replace smart quotes with straight quotes and use inline code for technical terms - fix `plusbeta` switch to include `--` prefix - apply Microsoft style guide contractions and wording --------- Co-authored-by: Andrew Connell <me@andrewconnell.com>
1 parent 820c763 commit 0437af5

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

docs/spfx/publish-to-marketplace-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Publish SharePoint Framework applications to the marketplace
3-
description: Considerations for publishing SharePoint Framework applications to the marketplace
4-
ms.date: 01/13/2021
3+
description: Considerations for publishing SharePoint Framework applications to the marketplace.
4+
ms.date: 03/25/2026
55
ms.localizationpriority: high
66
---
77

@@ -10,13 +10,13 @@ ms.localizationpriority: high
1010
Publishing your SharePoint Framework solutions to [marketplace (also known as AppSource)](https://appsource.microsoft.com/) and to SharePoint store, which allows you to reach other organizations and let them easily install your application in their Microsoft 365 tenant. Following sections describe considerations that you should take into account before publishing your solutions to the marketplace.
1111

1212
> [!NOTE]
13-
> Please see the [Microsoft 365 App Stores documentation](/office/dev/store/) for the general process for submitting your solution to the store. This guidance is the same for all different application types in Microsoft 365. Documentation also includes details on the submission process.
13+
> See the [Microsoft 365 App Stores documentation](/office/dev/store/) for the general process for submitting your solution to the store. This guidance is the same for all different application types in Microsoft 365. Documentation also includes details on the submission process.
1414
1515
> [!IMPORTANT]
16-
> You will need to use SharePoint Framework v1.11 or later for the solutions which are submitted to store.
16+
> You'll need to use SharePoint Framework v1.11 or later for the solutions that are submitted to store. However, we recommend using the latest supported version of SPFx (v1.16 or later) for new solutions.
1717
1818
> [!IMPORTANT]
19-
> All SharePoint Framework solutions will be targeted for SharePoint store. They can be also enabled for Microsoft Teams usage and the deployment will happen to Microsoft Teams gallery through the specific tenant's SharePoint app catalog. There is currently no option to only target Microsoft Teams store for SharePoint Framework based extensibility. This might be enabled in future based on the partner demand.
19+
> All SharePoint Framework solutions will be targeted for SharePoint store. They can be also enabled for Microsoft Teams usage and the deployment will happen to Microsoft Teams gallery through the specific tenant's SharePoint app catalog. There's currently no option to only target Microsoft Teams store for SharePoint Framework-based extensibility.
2020
2121
* [SharePoint Framework specific validation checklist](publish-to-marketplace-checklist.md)
2222
* [After publishing your app](publish-to-marketplace-after-publishing.md)

docs/spfx/subscribe-to-list-notifications.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Subscribe to list notifications
3-
description: Get notified and respond to changes to files in SharePoint Document Libraries
4-
ms.date: 04/27/2020
3+
description: Get notified and respond to changes to files in SharePoint Document Libraries.
4+
ms.date: 03/25/2026
55
ms.localizationpriority: medium
66
---
77

@@ -17,11 +17,14 @@ To use the SharePoint Framework list subscription capability, you first need to
1717
npm install @microsoft/sp-list-subscription --save --save-exact
1818
```
1919

20+
> [!IMPORTANT]
21+
> The SharePoint Framework list subscription capability (`@microsoft/sp-list-subscription`) has limited usage and isn't commonly used in modern solutions. For production scenarios, consider using Microsoft Graph change notifications or SharePoint webhooks to track changes in lists and document libraries.
22+
2023
## Get notified of changes to documents stored in a SharePoint Document Library
2124

2225
To subscribe to changes to files stored in a SharePoint Document Library, create an instance of the `ListSubscriptionFactory` class. Next, call the `createSubscription()` method passing the ID of the Document Library to which you want to subscribe. If the Document Library is located in the current site, it's sufficient to specify just the library ID. If it's located in a different site or site collection, then you need to specify their IDs as well.
2326

24-
Following, is an example of a list subscription for a Document Library located in the current site:
27+
Following is an example of a list subscription for a Document Library located in the current site:
2528

2629
```typescript
2730
import { ListSubscriptionFactory, IListSubscription } from '@microsoft/sp-list-subscription';
@@ -49,7 +52,7 @@ export default class LatestDocumentsWebPart extends BaseClientSideWebPart<ILates
4952
}
5053
```
5154

52-
When creating a list subscription, using the `callbacks.notification` property, you have to specify the method that should be called, when a change has been detected. The method doesn't have any arguments, and for security reasons, you don't get notified what has been changed exactly. To get the latest contents of the Document Library, adhering to the configured permissions, you can use either the SharePoint REST APIs or the Microsoft Graph.
55+
When creating a list subscription, using the `callbacks.notification` property, you have to specify the method that should be called, when a change has been detected. The method doesn't have any arguments, and for security reasons, you aren't provided with details about what specifically changed. To get the latest contents of the Document Library, adhering to the configured permissions, you can use either the SharePoint REST APIs or the Microsoft Graph.
5356

5457
## Additional configuration
5558

@@ -75,7 +78,7 @@ this._listSubscriptionFactory.createSubscription({
7578

7679
In some cases, you might want to get notified when the component that you're building successfully subscribed to list notifications or if the connection has been broken. This would allow you to communicate the connection to the user through the UI.
7780

78-
The list subscription API, exposes two additional callbacks that you can implement to respond to the subscription status. The following code illustrates the case, where the component will be notified when the subscription has been established and when it was disconnected.
81+
The list subscription API exposes two additional callbacks that you can implement to respond to the subscription status. The following code illustrates the case, where the component will be notified when the subscription has been established and when it was disconnected.
7982

8083
```typescript
8184
private createListSubscription(): void {
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
22
title: Try SharePoint Framework preview capabilities
33
description: Details on how to use new "in preview" packages with SharePoint Framework or newer versions.
4-
ms.date: 06/05/2018
4+
ms.date: 03/25/2026
55
ms.localizationpriority: medium
66
---
77

88
# Try SharePoint Framework preview capabilities
99

10-
Starting from version 1.5.0, you can try preview capabilities in the SharePoint Framework. This article outlines how to create SharePoint Framework projects using preview capabilities and the considerations that you should take into account when working with the preview capabilities.
10+
You can try preview capabilities in the SharePoint Framework starting from version 1.5.0. This article outlines how to create SharePoint Framework projects using preview capabilities and what to consider when using them.
1111

1212
> [!IMPORTANT]
13-
> Creating SharePoint Framework projects using preview capabilities is meant for evaluation purposes only. Deploying projects using preview capabilities to production environments is not supported. Microsoft doesn't guarantee that any of the preview capabilities will be released to production tenants. Microsoft can change or remove preview capabilities without any prior notice.
13+
> Creating SharePoint Framework projects using preview capabilities is meant for evaluation purposes only. Deploying projects using preview capabilities to production environments isn't supported. Microsoft doesn't guarantee that any of the preview capabilities will be released to production tenants. Microsoft can change or remove preview capabilities without any prior notice.
1414
1515
## What are SharePoint Framework preview features?
1616

1717
As the SharePoint Framework evolves, Microsoft would like to get feedback on the different capabilities considered for adding to the SharePoint Framework. At the same time, organizations have been asking for preview of future capabilities both to provide feedback and take them into account for their future projects.
1818

19-
Starting from version 1.5.0, Microsoft offers the ability for organizations to evaluate preview capabilities in SharePoint Framework. These capabilities are available through a separate set of npm packages tagged with the _plusbeta_ label and range from additional API options to complete features. Even though commonly labels in SemVer are used to denote a pre-release, in this case, the _plusbeta_ label indicates that the npm package contains additional preview functionality. For example, the _1.5.0-plusbeta_ version of the SharePoint Framework includes all the functionality released in the _1.5.0_ version plus some extra experimental features.
19+
Microsoft introduced the ability to evaluate preview capabilities in SharePoint Framework with v1.5.0. These capabilities are available through a separate set of npm packages tagged with the `plusbeta` label and range from additional API options to complete features. Even though commonly labels in SemVer are used to denote a pre-release, in this case, the `plusbeta` label indicates that the npm package contains additional preview functionality. For example, the **1.5.0-plusbeta** version of the SharePoint Framework includes all the functionality released in v1.5.0 plus some extra experimental features.
2020

21-
When scaffolding SharePoint Framework projects using the regular SharePoint Framework Yeoman generator (_@microsoft/generator-sharepoint_), you can choose if you want to use the preview capabilities or not. Based on your choice, the generator will create a project which you can run in a production environment or a project that you can use to evaluate the experimental features. You should keep in mind, that there is no guarantee that the capabilities from a _plusbeta_ version will be released in a future version of the SharePoint Framework and using solutions built using the _plusbeta_ version in production is not supported.
21+
When scaffolding SharePoint Framework projects using the regular SharePoint Framework Yeoman generator (_@microsoft/generator-sharepoint_), you can choose if you want to use the preview capabilities or not. Based on your choice, the generator will create a project that you can run in a production environment or a project that you can use to evaluate the experimental features. You should keep in mind, that there's no guarantee that the capabilities from a `plusbeta` version will be released in a future version of the SharePoint Framework and using solutions built using the `plusbeta` version in production isn't supported.
2222

2323
> [!NOTE]
2424
> Feedback on provided preview capabilities is welcome using the [issue list](https://aka.ms/spdev-issues) at sp-dev-docs GitHub repository.
2525
2626
## Create SharePoint Framework projects using preview features
2727

28-
Starting from version 1.5.0, you can use the SharePoint Framework Yeoman generator to create projects that use preview features of the SharePoint Framework. To include preview capabilities, add the `plusbeta` switch to the `yo` command, for example:
28+
You can use the SharePoint Framework Yeoman generator to create projects with preview features (available since version 1.5.0). To include preview capabilities, add the `--plusbeta` switch to the `yo` command, for example:
2929

3030
```sh
3131
yo @microsoft/sharepoint --plusbeta
3232
```
3333

34-
After executing this command, the SharePoint Framework Yeoman generator, will scaffold a new SharePoint Project using whatever preview capabilities are available at that moment. For additional information about the available preview capabilities, refer to the release notes of the SharePoint Framework Yeoman generator.
34+
After executing this command, the SharePoint Framework Yeoman generator will scaffold a new SharePoint Project using whatever preview capabilities are available at that moment. For more information about the available preview capabilities, see the release notes of the SharePoint Framework Yeoman generator.
3535

36-
If _plusbeta_ switch was used, package.json will reference different packages for the scaffolded project with the _@plusbeta_ tag.
36+
If `--plusbeta` switch was used, package.json will reference different packages for the scaffolded project with the `@plusbeta` tag.

0 commit comments

Comments
 (0)