Skip to content

Commit a342dfb

Browse files
authored
Merge pull request SharePoint#1887 from ajford76/adfor_spcna
Adding design content.
2 parents f5328b7 + 29c52ee commit a342dfb

23 files changed

+159
-252
lines changed

docs/design/empty-states.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Empty states for web parts
3+
description: The empty state is a visual representation of a web part, pre-configured to a content source like a list or with placeholder content, such as images and text.
4+
ms.date: 4/16/2018
5+
---
6+
7+
# Empty state of a web part
8+
9+
The empty state is a visual representation of a web part, pre-configured to a content source like a list or with placeholder content, such as images and text.
10+
11+
The following web parts have a content source set by default but no content to show for a newly created Communication site (that is, they feature an empty state):
12+
13+
- Highlighted content
14+
- News
15+
- Site activity
16+
- Events
17+
- Hero
18+
- Image gallery
19+
20+
Empty states are designed to convey the purpose, stucture, and layout options of web parts before the web part is configured or content is added. The empty state is also a perfect way to illustrate the vertical rhythm and layout of a page that starts from a template. Empty states behave similarly to fully configured web parts, and reflow to accommodate available space. They should support author-configured web part layouts.
21+
22+
![Image that shows sample web part empty states](../images/empty_state_template_01.png)
23+
24+
Empty states are different from placeholders in that the latter are meant to be displayed as a fallback when no content is added, or to help the author configure the web part. To learn more about placeholders, see [Placeholders and fallbacks in SharePoint web parts](placeholders-and-fallbacks.md).
25+
26+
## Empty state and editing rights
27+
28+
Web parts with empty states can change interaction options and display text depending on the permission level and mode of the page.
29+
30+
In the following example (left to right), a person with editing rights sees an empty state of the Events web part in Edit and Read modes. The last image shows a simplified empty state view for page readers that have no editing rights, with a message appropriate to their permission level.
31+
32+
![Author amd reader empty states](../images/empty_state_events_02.png)
33+
34+
The following are layout options for the Events web part in an empty state.
35+
36+
![Events web part empty states](../images/empty_state_ctas_03.png)
37+
38+
## Interactions with an empty state
39+
40+
Empty states are designed primarily for people with editing rights and change interaction options based on the current page mode. Authors can manually add content to web parts in the Read mode, such as adding a new event or new news post.
41+
42+
The following example shows an empty state with multiple items stacked vertically, where the first item acts as a call to action (CTA) to learn more or create an event.
43+
44+
![Call to action example empty state cards](../images/empty_state_views_04.png)
45+
46+
## Empty state with pre-provisioned content
47+
48+
The Hero web part is an example of an empty state with pre-provisioned content and text. The empty state is designed to help authors understand the options and the layout capabilities of the web part. The empty state in this case is a visual template for the web part. When pre-provisioning content for an empty state make sure end users have rights to publish the content (images, illustrations, etc.) in their pages.
49+
50+
![Hero web part empty state with images and helpful text](../images/empty_state_unique_05.png)

docs/design/key-web-part-examples.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Key web part examples
3+
description: A visual overview of Communication site and Team site templates.
4+
ms.date: 5/08/2018
5+
---
6+
7+
# Key web part examples
8+
9+
Web parts are the building blocks of your page.
10+
11+
This is a visual overview of Communication site and Team site templates, highlighting how web parts work together to create a coherent overall design. Use these pages as reference when designing a SharePoint web part.
12+
13+
It is important to consider how the web part will look and function when sitting next to other web parts on a page. Follow the patterns in this documentation and on the [Office UI Fabric site](https://developer.microsoft.com/en-us/fabric) to ensure consistency in layout and grid alignment, font size and hierarchy, commanding, empty states, and more.
14+
15+
## Communication sites
16+
17+
### Topic design
18+
19+
The Topic design is used when you have a lot of information to share, such as news, events, reports, and other content. It is built from the Hero, News, Events, Highlighted content, Quick links, and People web parts.
20+
21+
![Topic site homepage](../images/sites_topic.png)
22+
23+
24+
### Showcase design
25+
26+
The Showcase design is used to feature a product, team, or event. It leverages the Hero and Image gallery web parts to show rich visual content.
27+
28+
![Showcase site homepage](../images/sites_showcase.png)
29+
30+
## Team sites
31+
32+
The Team site design is the default layout for any new team. It features the News, Quick links, Highlighted content, and Document library web parts.
33+
34+
![Team site homepage](../images/sites_teamsite.png)
35+
36+
These example site and web part designs have been added to the SharePoint toolkit and can be used as reference when designing web parts.
37+
For more information, see the [SharePoint toolkit](https://developer.microsoft.com/en-us/fabric#/resources).
38+
39+

0 commit comments

Comments
 (0)