Skip to content

Commit e4bf60e

Browse files
committed
2 parents a15a891 + 258fb93 commit e4bf60e

File tree

7 files changed

+83
-31
lines changed

7 files changed

+83
-31
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ALM APIs are natively provided using REST APIs, but there is also additional CSO
3333
Adding solution to the tenant app catalog. This API is designed to be executed in the context of the tenant app catalog site.
3434

3535
```
36-
/_api/web/tenantappcatalog/Add(overwrite=true, url='test.txt')";
36+
url: /_api/web/tenantappcatalog/Add(overwrite=true, url='test.txt')
3737
method: POST
3838
binaryStringRequestBody: true
3939
body: 'byte array of the file'
@@ -44,7 +44,7 @@ body: 'byte array of the file'
4444
Enable solution to be available to install to specific sites. This API is designed to be executed in the context of the tenant app catalog site.
4545

4646
```
47-
/_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Deploy";
47+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Deploy
4848
```
4949

5050
> [!NOTE]
@@ -55,7 +55,7 @@ Enable solution to be available to install to specific sites. This API is design
5555
Retract solution to be available from the sites. This API is designed to be executed in the context of the tenant app catalog site.
5656

5757
```
58-
/_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Retract";
58+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Retract
5959
```
6060

6161
> [!NOTE]
@@ -66,7 +66,7 @@ Retract solution to be available from the sites. This API is designed to be exec
6666
Remove the solution package from the tenant app catalog. This API is designed to be executed in the context of the tenant app catalog site.
6767

6868
```
69-
/_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Remove";
69+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Remove
7070
```
7171

7272
> [!NOTE]
@@ -95,7 +95,7 @@ method: GET
9595
Install a solution package with specific identifier from tenant app catalog to the site based on URL context. This REST call can be executed in the context of the site where the install operation should happen.
9696

9797
```
98-
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Install";
98+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Install
9999
method: POST
100100
```
101101

@@ -104,7 +104,7 @@ method: POST
104104
Upgrade a solution package from the site to a newer version available in the tenant app catalog. This REST call can be executed in the context of the site where the upgrade operation should happen.
105105

106106
```
107-
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Upgrade";
107+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Upgrade
108108
method: POST
109109
```
110110

@@ -113,7 +113,7 @@ method: POST
113113
Uninstall a solution package from the site. This REST call can be executed in the context of the site where the uninstall operation should happen.
114114

115115
```
116-
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Uninstall";
116+
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Uninstall
117117
method: POST
118118
```
119119
> [!NOTE]
@@ -128,7 +128,7 @@ Using [PnP PowerShell](https://msdn.microsoft.com/en-us/pnp_powershell/pnp-power
128128
Adding your app (.sppkg file, .app file) to the tenant app catalog is a per-requisite to later on make your app available for use in your SharePoint sites. Doing so can be done using below simple cmdlet:
129129

130130
```PowerShell
131-
Add-PnPApp -Path ./myapp.sppkg"
131+
Add-PnPApp -Path ./myapp.sppkg
132132
```
133133

134134
Once added you'll need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. Below PnP PowerShell cmdlets shows how this can be done:

docs/declarative-customization/column-formatting.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,51 @@ This example relies on two number fields, `Before` and `After`, for which the va
594594
}
595595
```
596596

597+
## Create a button to launch a Flow
598+
The following screenshot shows a list with a Flow button added to the Action column:
599+
600+
![screenshot of the sample](../images/sp-columnformatting-flow.png)
601+
602+
You can use column formatting to create buttons that, when clicked, run Flows on the corresponding list item. If the Flow is configured to gather data from the end user before running, the Flow Launch Panel will be displayed after clicking the button. Otherwise, the Flow will just run.
603+
604+
To use the sample below, you must substitute the ID of the Flow you want to run. This ID is contained within the `customRowAction` attribute inside the `button` element. To obtain a Flow's ID:
605+
606+
1. Click Flow > See your flows in the SharePoint list where the Flow is configured.
607+
2. Click on the Flow you want to run
608+
3. Copy the ID from the end of the URL.
609+
610+
```
611+
{
612+
"$schema": "http://columnformatting.sharepointpnp.com/columnFormattingSchema.json",
613+
"elmType": "span",
614+
"style": {
615+
"color": "#0078d7"
616+
},
617+
"children": [
618+
{
619+
"elmType": "span",
620+
"attributes": {
621+
"iconName": "Flow"
622+
}
623+
},
624+
{
625+
"elmType": "button",
626+
"style": {
627+
"border": "none",
628+
"background-color": "transparent",
629+
"color": "#0078d7",
630+
"cursor": "pointer"
631+
},
632+
"txtContent": "Send to Manager",
633+
"customRowAction": {
634+
"action": "executeFlow",
635+
"actionParams": "{\"id\": \"183bedd4-6f2b-4264-855c-9dc7617b4dbe\"}"
636+
}
637+
}
638+
]
639+
}
640+
```
641+
597642
## Supported Column Types
598643
The following column types support column formatting:
599644
* Single line of text
@@ -667,6 +712,7 @@ Specifies the type of element to create. Valid elements include:
667712
- img
668713
- svg
669714
- path
715+
- button
670716

671717
Any other value will result in an error.
672718

Loading

docs/declarative-customization/site-design-pnp-provisioning.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ You'll need to download the PnP PowerShell module so that you can upload it for
185185
```powershell
186186
Save-Module -Name SharePointPnPPowerShellOnline -Path [pathtoyourfolder]
187187
```
188+
188189
The PowerShell module files will download to a folder within the folder that you created.
189190
190191
Next, upload the files so that your Azure Function can use the module.
@@ -254,24 +255,24 @@ To create a site design, you first need to create a site script. A site design i
254255

255256
`https://prod-27.westus.logic.azure.com:443/workflows/ef7434cf0d704dd48ef5fb6...oke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun`
256257

257-
```json
258+
```json
259+
{
260+
"$schema": "schema.json",
261+
"actions": [
258262
{
259-
"$schema": "schema.json",
260-
"actions": [
261-
{
262-
"verb": "triggerFlow",
263-
"url": "[paste the workflow trigger URL here]",
264-
"name": "Apply Template",
265-
"parameters": {
266-
"event":"",
267-
"product":""
268-
}
269-
}
270-
],
271-
"bindata": {},
272-
"version": 1
263+
"verb": "triggerFlow",
264+
"url": "[paste the workflow trigger URL here]",
265+
"name": "Apply Template",
266+
"parameters": {
267+
"event":"",
268+
"product":""
269+
}
273270
}
274-
```
271+
],
272+
"bindata": {},
273+
"version": 1
274+
}
275+
```
275276

276277
1. Select the JSON again and copy it again to your clipboard.
277278
1. Open PowerShell and enter the following to copy the script into a variable and create the site script:

docs/declarative-customization/site-design-rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ ms.date: 12/14/2017
1111
1212
You can use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site designs and site scripts.
1313

14-
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. For details and links to code samples, see [Make batch requests with the REST APIs](https://dev.office.com/sharepoint/docs/apis/rest/make-batch-requests-with-the-rest-apis.md).
14+
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. For details and links to code samples, see [Make batch requests with the REST APIs](https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis).
1515

1616
## Prerequisites
1717
Before you get started, make sure that you're familiar with the following:
18-
- [Get to know the SharePoint REST service](https://dev.office.com/sharepoint/docs/apis/rest/get-to-know-the-sharepoint-rest-service.md)
19-
- [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md)
18+
- [Get to know the SharePoint REST service](https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service)
19+
- [Complete basic operations using SharePoint REST endpoints](https://docs.microsoft.com/en-us/sharepoint/dev/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints)
2020

2121
## REST commands
2222

docs/spfx/office-ui-fabric-integration.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ The challenge with Global CSS styles is explained in the following presentation
1616

1717
To achieve reliability, one of the main problems we need to solve is that of **Global CSS styles**. This accounts to not using global class names in the HTML markup and instead using Fabric Core mixins and variables in the Sass declaration file. This involves importing the Fabric Core's Sass declarations in your Sass file and then consuming the variables and mixins appropriately.
1818

19-
The goal of the SharePoint Framework is to allow both Microsoft and customers to build rich, beautiful, and consistent user experiences on top of SharePoint. In accordance with these goals, following are the key design principles:
19+
In order to achieve reliability, one of the main problems we need to solve is that of **Global CSS styles**. This accounts to not using global class names in the HTML markup and instead using Fabric Core mixins and variables in the SASS declaration file. This involves importing the Fabric Core's SASS declarations in your SASS file and then consuming the variables and mixins appropriately.
20+
21+
## Goals
22+
23+
The goal of the SharePoint Framework is to allow both Microsoft and customers to build rich, beautiful, and consistent user experiences on top of SharePoint.
24+
In accordance with these goals, following are the key design principles:
2025

2126
* Customers should be able to smoothly and reliably consume Fabric Core and Fabric React in their solutions.
2227
* Microsoft will roll out updated experiences that consume updated versions of Fabric Core and Fabric React in SharePoint without conflicting with customer's solutions.

docs/spfx/toolchain/integrate-gulp-tasks-in-build-pipeline.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ You can also add this custom task to be executed before or after certain availab
8686
The SharePoint Framework tasks are available in the default build rig. The build rig is a collection of tasks defined for a specific purpose. In our case, building client-side packages. You can access this default rig using the `build.rig` object and get access to the pre and post task functions:
8787

8888
```js
89-
//execute before the typescript subtask
89+
// execute before the TypeScript subtask
9090
build.rig.addPreBuildTask(helloWorldTask);
9191

92-
// execute after TypeScript task
92+
// execute after TypeScript subtask
9393
build.rig.addPostTypescriptTask(helloWorldTask);
9494

95-
//execute after all tasks
95+
// execute after all tasks
9696
build.rig.addPostBuildTask(helloWorldTask);
9797
```
9898

0 commit comments

Comments
 (0)