Skip to content

Commit d24db29

Browse files
melitoSPVesaJuvonen
authored andcommitted
Reflect new branding and nav capabilities (SharePoint#4091)
1 parent ea8f2af commit d24db29

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

docs/declarative-customization/site-design-json-schema.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,12 +590,13 @@ Subaction to remove a site column from a list or content type.
590590

591591
## Add a navigation link
592592

593-
Use the **addNavLink** verb to add a new navigation link to the site.
593+
Use the **addNavLink** verb to add a new navigation link to the site QuickLaunch or Hub navigation.
594594

595595
#### JSON values
596596

597597
- **url** – The url of the link to add.
598598
- **displayName** – The display name of the link.
599+
- **navComponent** – The component where to add the link, QuickLaunch or Hub. The default is **QuickLaunch**.
599600
- **isWebRelative** – **true** if the link is web relative; otherwise, **false**. The default is **false**.
600601
- **parentDisplayName** – An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this displayName. If both this and parentUrl are provided, it searches for a link that matches both to be the parent.
601602
- **parentUrl** – An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this url. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent.
@@ -606,12 +607,12 @@ Use the **addNavLink** verb to add a new navigation link to the site.
606607
> [!NOTE]
607608
> If you add a link to a nested site item such as a list, be sure to add the path reference from the root.
608609
609-
610610
```json
611611
{
612612
"verb": "addNavLink",
613613
"url": "/Customer Event Collateral",
614614
"displayName": "Event Collateral",
615+
"navComponent":"Hub",
615616
"isWebRelative": true
616617
},
617618
{
@@ -636,6 +637,7 @@ Use the **removeNavLink** verb to remove a navigation link from the site.
636637

637638
- **url** – The url of the link to remove.
638639
- **displayName** – The display name of the link.
640+
- **navComponent** – The component where to remove the link from, QuickLaunch or Hub. The default is **QuickLaunch**.
639641
- **isWebRelative** – **True** if the link is web relative; otherwise, **false**.
640642

641643
#### Example
@@ -730,6 +732,30 @@ Use the **createPage** verb to create a new page on the site.
730732
```
731733
-->
732734

735+
## Set branding properties
736+
737+
Use the **setSiteBranding** verb to specify the navigation layout, the header layout and header background.
738+
739+
> [!NOTE]
740+
> Setting the navigation layout only works on the communication site template and for the hub navigation.
741+
742+
#### JSON value
743+
744+
- **navigationLayout** – Specify the navigation layout as Cascade or Megamenu
745+
- **headerLayout** – Specify the header layout as Standard or Compact
746+
- **headerBackground** – Specify the header background as None, Neutral, Soft or Stong
747+
748+
#### Example
749+
750+
```json
751+
{
752+
"verb": "setSiteBranding",
753+
"navigationLayout": "Megamenu",
754+
"headerLayout": "Compact",
755+
"headerBackground": "Strong"
756+
}
757+
```
758+
733759
## Set a site logo
734760

735761
Use the **setSiteLogo** verb to specify a logo for your site.

0 commit comments

Comments
 (0)