Skip to content

Commit 8bd69b6

Browse files
committed
Adding initial documentation for the site footer
1 parent f4bcbcc commit 8bd69b6

File tree

6 files changed

+70
-1
lines changed

6 files changed

+70
-1
lines changed

docs/features/site-footer.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Overview of the SharePoint Site footer
3+
description: SharePoint Site footers can be used to show a logo or set of links/labels in a modern SharePoint site. They can be configured using the UI settings or by using APIs.
4+
ms.date: 1/22/2019
5+
localization_priority: Priority
6+
---
7+
8+
# SharePoint Site Footer
9+
10+
Footers are a common branding / navigation control in websites and portals. SharePoint Communication sites will have an out-of-the box footer control, which can be controlled either using UI elements or by using APIs. This control supports following elements
11+
12+
- 8 links or labels
13+
- Footer logo or footer name
14+
15+
> [!NOTE]
16+
> Site footers are current supported only in modern pages of communication sites. This feature is scheduled to start production roll out in January 2019.
17+
18+
> [!IMPORTANT]
19+
> Footer will be enabled by default for all new and existing communication sites when the faeture is initially rolled out.
20+
21+
## Footer with a logo
22+
23+
Following picture demonstrates a footer with a logo with additional labels and links.
24+
25+
![Image showing a site footer with a logo](../images/footer-with-a-logo.png)
26+
27+
## Footer with a label
28+
29+
Following picture demonstrates a footer with a label with additional labels and links.
30+
31+
![Image showing a site footer with a label](../images/footer-with-a-label.png)
32+
33+
## Controlling footer rendering using code or PowerShell
34+
35+
When this feature is initially released, all new and existing communication sites will get a footer by default. If you do not want the out-of-box footer in your existing communication site, you can pre-emptively turn it off before the feature rolls out to your site or disable the footer after feature is enabled.
36+
37+
You can control the footer existence with a `FooterEnabled` property in the `Web` object. Following PowerShell scripts shows how this can be done using [PnP PowerShell cmdlets](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps):
38+
39+
```ps
40+
41+
Connect-PnPOnline -Url "<SiteURL>" –Credentials (Get-Credential)
42+
$web = Get-PnPWeb
43+
$web.FooterEnabled = $false
44+
$web.Update()
45+
Invoke-PnPQuery
46+
47+
```
48+
49+
> [!NOTE]
50+
> Above PowerShell scripts assumes that you have already installed PnP PowerShell cmdlets for your environment and you are not using multi-factor authentication. You can install PnP PowerShell cmdlets to your computer by opening PowerShell console in administrative mode and executing following command: `Install-Module SharePointPnPPowerShellOnline`. If you are using multi-factor authentication, you can enable MFA login by updating the `Connect-PnPOnline` line as follows: `Connect-PnPOnline -Url "<SiteURL>" -UseWebLogin`.
51+
52+
## Controlling footer using the user interface
53+
54+
Site owner can control the footer visibility using the **Change the look** functionality of the site, which exposes the different user interface configuration options.
55+
56+
> [!NOTE]
57+
> These options will be visible in the sites when the feature(s) are rolled out and released.
58+
59+
![Change the look configuration options](../images/footer-change-the-look.png)
60+
61+
Footer configuration has multiple different options, which can be configured based on the site objectives.
62+
63+
![Footer UI configuration options](../images/footer-ui-configuration.png)
64+
65+
## See also
66+
67+
- [Change the look of your SharePoint site](https://support.office.com/en-us/article/change-the-look-of-your-sharepoint-site-06bbadc3-6b04-4a60-9d14-894f6a170818)
12.5 KB
Loading
14 KB
Loading

docs/images/footer-with-a-label.png

357 KB
Loading

docs/images/footer-with-a-logo.png

534 KB
Loading

docs/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,9 @@
397397
- name: View formatting
398398
href: declarative-customization/view-formatting.md
399399
- name: Communication site
400-
href: apis/communication-site-creation-rest.md
400+
href: apis/communication-site-creation-rest.md
401+
- name: Site Footer
402+
href: features/site-footer.md
401403
- name: Shorter share links
402404
href: spfx/shorter-share-link-format.md
403405
- name: SharePoint development overview

0 commit comments

Comments
 (0)