Skip to content

Commit 7f5f54c

Browse files
Address incorrect documentation around 'features' (#10425)
* Update notes-on-solution-packaging.md Update notes around using features and correctly state what will happen if the features is left as an empty array * Update notes-on-solution-packaging.md Update ms.date * Revise SharePoint solution packaging documentation Updated the metadata and content structure for the SharePoint solution packaging documentation. --------- Co-authored-by: Andrew Connell <me@andrewconnell.com>
1 parent d2cfc53 commit 7f5f54c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/spfx/web-parts/basics/notes-on-solution-packaging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SharePoint solution packaging
33
description: The package-solution gulp task looks at /config/package-solution.json for various configuration details in SharePoint Framework, including ISolution and IFeature definitions.
4-
ms.date: 10/26/2020
4+
ms.date: 10/01/2025
55
ms.localizationpriority: high
66
---
77
# SharePoint solution packaging
@@ -45,12 +45,12 @@ interface ISolution {
4545
Each solution file must have a `name` that identifies the package in the SharePoint UI. Additionally, each package must contain a globally unique identifier (`id`), which is used internally by SharePoint. Optionally, you may also specify a `version` number in the format "X.X.X.X", which is used to identify various versions of the package when upgrading.
4646

4747
> [!NOTE]
48-
> The versioning system only applies to Feature Framework and SharePoint Feature definitions included in the package. Code and assets from the new version of the package are available as soon as new version of the package is added to App Catalog with no need to update the app on sites.
48+
> The versioning system only applies to Feature Framework and SharePoint Feature definitions included in the package. Code and assets from the new version of the package are available as soon as the new version of the package is added to App Catalog, with no need to update the app on sites.
4949
5050
The solution definition also optionally contains a list of SharePoint Feature definitions.
5151

5252
> [!NOTE]
53-
> If this is omitted or empty, the task creates a single Feature for every component (a 1:1 mapping).
53+
> If the `features` property is omitted, the task creates a single Feature for every component (a 1:1 mapping). An empty array will produce no features, and the web parts will not be added.
5454
5555
## Feature definition (IFeature)
5656

@@ -68,7 +68,7 @@ interface IFeature {
6868

6969
It's important to note that this is a definition for creating a SharePoint feature, and that some of these options are exposed in the UI. Similarly to the solution, each feature has a mandatory `title`, `description`, `id`, and `version` number (in the X.X.X.X format). The feature `id` should also be a globally unique identifier.
7070

71-
Each feature can also contain any number of components that are activated when the feature is activated. This is defined via a list of `componentIds`, that are globally unique identifiers that *must* match the **ID** in the component's manifest file. If this list is undefined or empty, the packager includes *every* component in the feature.
71+
Each feature can also contain any number of components that are activated when the feature is activated. This is defined via a list of `componentIds`, which are globally unique identifiers that *must* match the **ID** in the component's manifest file. If this list is undefined or empty, the packager includes *every* component in the feature.
7272

7373
## File paths
7474

0 commit comments

Comments
 (0)