Skip to content

Commit ad3f25a

Browse files
committed
Update for SPFx 1.14
1 parent 373f2a4 commit ad3f25a

File tree

3 files changed

+29
-19
lines changed

3 files changed

+29
-19
lines changed
45.4 KB
Loading
15 KB
Loading

docs/spfx/extensions/get-started/serving-your-extension-from-sharepoint.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,10 @@ The `ClientSideComponentProperties` property is set to the default structure and
6565

6666
The configuration uses the specific ___location of `ClientSideExtension.ApplicationCustomizer` to define that this is an Application Customizer. Because this **elements.xml** is associated to a `Web` scoped feature by default, this `CustomAction` is automatically added to the `Web.UserCustomAction` property in the site where the solution is being installed.
6767

68-
Ensure that the configuration matches updates executed in the Application Customizer. Update the `ClientSideComponentProperties` as in the following XML structure. Don't copy the whole structure because it would cause a mismatch with your `ClientSideComponentId`:
68+
Ensure that the configuration matches the changes made to the properties of the Application Customizer. Set the `ClientSideComponentProperties` property to the following HTML encoded JSON string that contains the property values:
6969

7070
```xml
71-
<?xml version="1.0" encoding="utf-8"?>
72-
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
73-
<CustomAction
74-
Title="SPFxApplicationCustomizer"
75-
Location="ClientSideExtension.ApplicationCustomizer"
76-
ClientSideComponentId="46606aa6-5dd8-4792-b017-1555ec0a43a4"
77-
ClientSideComponentProperties="{&quot;Top&quot;:&quot;Top area of the page&quot;,&quot;Bottom&quot;:&quot;Bottom area in the page&quot;}">
78-
</CustomAction>
79-
</Elements>
71+
{&quot;Top&quot;:&quot;Top area of the page&quot;,&quot;Bottom&quot;:&quot;Bottom area in the page&quot;}
8072
```
8173

8274
### What about ClientSideInstance.xml file in assets folder?
@@ -85,7 +77,7 @@ Ensure that the configuration matches updates executed in the Application Custom
8577

8678
**Tenant-Wide Extensions** list can be used to automatically activate extensions in tenant from a centralized ___location. Tenant-wide deployment is supported for Application customizers and list view command sets. You can specify different target definitions, like activation based on the site type or list type.
8779

88-
For this tutorial, we don't need this file as we'll be activating solution in a specific site using feature xml based provisioning.
80+
For this tutorial, we don't need this file as we'll be activating solution in a specific site using feature XML based provisioning.
8981

9082
> [!TIP]
9183
> For more information, see: [Tenant-wide Deployment of SharePoint Framework Extensions](../basics/tenant-wide-deployment-extensions.md)
@@ -122,15 +114,34 @@ The **./config/package-solution.json** now looks similar to the following exampl
122114
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
123115
"solution": {
124116
"name": "app-extension-client-side-solution",
125-
"id": "98a9fe4f-175c-48c1-adee-63fb927faa70",
117+
"id": "65e15d73-515b-4d57-8c92-66ba5890c7b4",
126118
"version": "1.0.0.0",
127119
"includeClientSideAssets": true,
120+
"skipFeatureDeployment": true,
128121
"isDomainIsolated": false,
122+
"developer": {
123+
"name": "",
124+
"websiteUrl": "",
125+
"privacyUrl": "",
126+
"termsOfUseUrl": "",
127+
"mpnId": "Undefined-1.14.0"
128+
},
129+
"metadata": {
130+
"shortDescription": {
131+
"default": "app-extension description"
132+
},
133+
"longDescription": {
134+
"default": "app-extension description"
135+
},
136+
"screenshotPaths": [],
137+
"videoUrl": "",
138+
"categories": []
139+
},
129140
"features": [
130141
{
131-
"title": "Application Extension - Deployment of custom action.",
142+
"title": "Application Extension - Deployment of custom action",
132143
"description": "Deploys a custom action with ClientSideComponentId association",
133-
"id": "4678966b-de68-445f-a74e-e553a7b937ab",
144+
"id": "41b490c7-49f7-4db4-b7ea-c632d0fb9785",
134145
"version": "1.0.0.0",
135146
"assets": {
136147
"elementManifests": [
@@ -164,12 +175,11 @@ Now you're ready to deploy the solution to a SharePoint site and have the `Custo
164175

165176
This command creates the following package: **./sharepoint/solution/app-extension.sppkg**.
166177

167-
1. You now need to deploy the package to the app catalog. Go to your tenant's **app catalog** and open the **Apps for SharePoint** library.
168-
1. Upload or drag and drop the **./sharepoint/solution/app-extension.sppkg** file to the app catalog. SharePoint displays a dialog and asks you to trust the client-side solution.
178+
1. You now need to deploy the package to the app catalog. Go to your tenant's **app catalog** and upload or drag and drop the **./sharepoint/solution/app-extension.sppkg** file into the **Apps for SharePoint** list. SharePoint displays a panel that asks you to enable the client-side solution.
169179

170180
We did not update the URLs for hosting the solution for this deployment, so the URL is still pointing to **https://localhost:4321**.
171181

172-
1. Select the **Deploy** button.
182+
1. Select the **Only enable this app** radio button and then select the **Enable app** button.
173183

174184
![Trust operation in app catalog upload](../../../images/ext-app-sppkg-deploy-trust.png)
175185

@@ -185,9 +195,9 @@ Now you're ready to deploy the solution to a SharePoint site and have the `Custo
185195

186196
![installing Field Customizer to site](../../../images/ext-app-install-solution-to-site.png)
187197

188-
1. Select the **app-extension-client-side-solution** app to install the solution on the site. When the installation is completed, refresh the page by selecting F5.
198+
1. Select the **app-extension-client-side-solution** app to install the solution on the site. When the installation is completed, navigate back to the site where you installed the app.
189199

190-
When the application has been successfully installed, you can see the header and footer being rendered just like with the debug query parameters.
200+
You can now see the header and footer being rendered just like with the debug query parameters.
191201

192202
![Custom header and footer elements rendered in the page](../../../images/ext-app-header-footer-visible.png)
193203

0 commit comments

Comments
 (0)