You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/declarative-customization/site-design-json-schema.md
+165-5Lines changed: 165 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Site design JSON schema
3
3
description: JSON schema reference for building site designs for SharePoint.
4
-
ms.date: 04/20/2018
4
+
ms.date: 05/25/2018
5
5
---
6
6
7
7
# Site design JSON schema
@@ -300,6 +300,101 @@ In this example, we are formatting a number column as a data bar.
300
300
}
301
301
```
302
302
303
+
### associateFieldCustomizer
304
+
305
+
Registers field extension for a list field. For more information on these client-side extensions, see [Build field customizer](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) tutorial.
306
+
307
+
#### JSON values
308
+
309
+
-**internalName**– The display name of the field to operate on.
310
+
-**clientSiteComponentId**– The identifier (GUID) of the extension in the app catalog. This property value can be found in the manifest.json file or in the elements.xml file.
311
+
-**clientSiteComponentProperties**– An optional parameter, which can be used to provide properties for the field customizer extension instance.
312
+
313
+
#### Example
314
+
315
+
```json
316
+
{
317
+
"verb": "createSPList",
318
+
"listName": "Custom List with Slider Extension",
319
+
"templateType": 100,
320
+
"subactions": [
321
+
{
322
+
"verb": "SetDescription",
323
+
"description": "Custom list to illustrate SharePoint site scripting"
"clientSideComponentProperties": "{\"sampleText\":\"Yes - added by a site design, what?\"}"
344
+
}
345
+
]
346
+
}
347
+
```
348
+
349
+
### associateListViewCommandSet
350
+
351
+
Sets column formatting for a field. For more information, see [Use column formatting to customize SharePoint](column-formatting.md).
352
+
353
+
#### JSON values
354
+
355
+
-**title**– The title of the extension.
356
+
-**___location**– A required parameter to specify where the command is displayed. Options are: ContextMenu or CommandBar.
357
+
-**clientSiteComponentId**– The identifier (GUID) of the extension in the app catalog. This property value can be found in the manifest.json file or in the elements.xml file.
358
+
-**clientSiteComponentProperties**– An optional parameter, which can be used to provide properties for the extension instance.
359
+
360
+
361
+
#### Example
362
+
363
+
```json
364
+
{
365
+
"verb": "createSPList",
366
+
"listName": "CustomList",
367
+
"templateType": 100,
368
+
"subactions": [
369
+
{
370
+
"verb": "SetDescription",
371
+
"description": "Custom list to illustrate SharePoint site scripting"
"clientSideComponentProperties": "{\"sampleText\":\"added by a site design\"}"
394
+
}
395
+
]
396
+
}
397
+
```
303
398
304
399
## Define a new site column
305
400
@@ -538,11 +633,10 @@ Use the **joinHubSite** verb to join the site to a designated hub site.
538
633
539
634
## Install an add-in or solution
540
635
541
-
Use the **installSPFXSolution** action to install a deployed add-in or SharePoint Framework solution from the tenant app catalog.
636
+
Use the **installSolution** action to install a deployed add-in or SharePoint Framework solution from the tenant app catalog.
542
637
543
638
#### JSON values
544
639
545
-
-**id**– The id of the add-in or solution in the tenant app catalog.
546
640
547
641
#### Example
548
642
@@ -551,11 +645,39 @@ Use the **installSPFXSolution** action to install a deployed add-in or SharePoin
551
645
552
646
```json
553
647
{
554
-
"verb": "installSPFXSolution",
648
+
"verb": "installSolution",
555
649
"id": "d40e4edc-a6da-4cd8-b82d-bba970976803"
556
650
}
557
651
```
558
652
653
+
## Register an extension
654
+
655
+
Use the **associateExtension** action to register a deployed SharePoint Framework extension from the tenant app catalog.
656
+
657
+
> [!NOTE]
658
+
> For more details on how to create and configure a SharePoint Framework extension, check out: [Overview of SharePoint Framework Extensions](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/extensions/overview-extensions).
659
+
660
+
#### JSON values
661
+
662
+
-**title**– The title of the extension in the app catalog.
663
+
-**___location**– Used to specify the extension type. If it is used to create commands, then where the command would be displayed; otherwise this should be set to ClientSideExtension.ApplicationCustomizer.
664
+
-**clientSiteComponentId**– The identifier (GUID) of the extension in the app catalog. This property value can be found in the manifest.json file or in the elements.xml file.
665
+
-**clientSiteComponentProperties**– An optional parameter, which can be used to provide properties for the extension instance.
666
+
-**registrationId**– An optional parameter, which indicates the type of the list the extension is associated to (if it is a list extension).
667
+
-**registrationType**– An optional parameter, which should be specified if the extension is associated with a list.
668
+
-**scope**– Indicates whether the extension is associated with a Web or a Site.
@@ -605,6 +727,44 @@ Use the **setRegionalSettings** action to configure the regional settings of the
605
727
}
606
728
```
607
729
730
+
731
+
## Add users (principals) to SharePoing Groups
732
+
733
+
Use the **addPrincipalToGroup** action to manage addition of users and groups to select default SharePoint groups. For more information, see [Understanding SharePoint Groups](https://support.office.com/en-us/article/Understanding-SharePoint-groups-94D9B261-161E-4ACE-829E-ECA1C8CD2EB8). This action can be used for licensed users, security groups, and Office 365 Groups.
734
+
735
+
#### JSON values
736
+
737
+
-**principal**– A required parameter to specify the name of the principal (user or group) to add to the SharePoint group.
738
+
-**group**– A required parameter to specify the SharePoint group to add the principal to.
739
+
740
+
#### Example
741
+
742
+
> [!NOTE]
743
+
> This action currently only supports the Visitors (permission level: read), Members (permission level: contribute or edit, depending on the site template), and Owners (permission level: full control) groups. Principals must be added individually.
Use the **setSiteExternalSharingCapability** action to manage guest access. For more information, see [Manage external sharing for your SharePoint Online environment](https://support.office.com/en-us/article/Manage-external-sharing-for-your-SharePoint-Online-environment-C8A462EB-0723-4B0B-8D0A-70FEAFE4BE85).
@@ -626,4 +786,4 @@ Use the **setSiteExternalSharingCapability** action to manage guest access. For
626
786
627
787
## See also
628
788
629
-
-[SharePoint site design and site script overview](site-design-overview.md)
789
+
-[SharePoint site design and site script overview](site-design-overview.md)
0 commit comments