Skip to content

Commit f86c78d

Browse files
ajford76VesaJuvonen
authored andcommitted
Ajford76 patch 1 (SharePoint#3108)
* Edits. * Edits. * Edits. * Edit. * Create semantic_slots.md * Add files via upload * Update semantic_slots.md * Update semantic_slots.md * Update semantic_slots.md * Add files via upload * Add files via upload * Update semantic_slots.md Edited article to simplify and follow cadence of other articles
1 parent d425a5c commit f86c78d

8 files changed

+109
-29
lines changed

docs/design/designing-a-web-part-icon.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ description: Learn how to design a web part icon that will look great in SharePo
44
ms.date: 08/24/2018
55
---
66

7-
# Designing a web part icon
7+
# Designing a SharePoint web part icon
88

9-
Web Part icons are designed to be simple, representative, and symbolic. Every icon is reduced to a minimalistic style to represent the most essential attributes. Icons will display in the toolbox within SharePoint pages and optionally in the store.
9+
Web part icons are designed to be simple, representative, and symbolic. Every icon is reduced to a minimalist style that represents the most essential attributes. Icons will display in the toolbox within SharePoint pages and optionally in the store. Examples of icon shapes are square, circle, veritical, and horizontal.
1010

1111
![Icon examples](../images/01_Icons_examples.png)
1212

1313
## Grid keyline shapes
1414

15-
Web parts icons are displayed at 32x32 px but designed at 2x the size or 64x64px. Create icons at 100% to ensure pixels are accurate.
15+
Web part icons are displayed at 32x32 px but are designed at twice the size, or 64x64 px. Create icons at 100% to ensure that pixels are accurate.
1616

1717
![Web part icon grid](../images/02_Icons_sizes.png)
1818

1919
## Layout
2020

21-
Icons should be designed inside of the 64 x 64 pixel container area, to insure that the icons renders correctly.
21+
Design icons within the 64x64 px container area. This ensures that the icon renders correctly.
2222

23-
![Example grid for web part icons at 64px](../images/03_Icons_Layout.png)
23+
![Grid example for web part icons at 64px](../images/03_Icons_Layout.png)
2424

2525
## Shapes
2626

27-
Not all icons or logos are designed in a perfect square. Use this guide of basic shapes to understand how to unify different icon shapes within the grid and appear at a proportional size. Make sure that the icon fills either the full width or height of the grid depending on its shape.
27+
Not all icons or logos are designed in a perfect square. Use this guide of basic shapes to understand how to unify different icon shapes within the grid and have them appear at a proportional size. Make sure that the icon fills either the full width or full height of the grid, depending on its shape.
2828

2929
![Example of aligning icons that are differnt shapes within the grid](../images/04_Icons_shapes.png)
3030

@@ -37,15 +37,15 @@ Try to avoid any icon distortion by snapping your edges to the X and Y coordinat
3737

3838
## Colors and backgrounds
3939

40-
The icon is the visual expression of your web part and its function. They can help communicate the core idea of your web part simply and boldly.
40+
The icon is the visual expression of your web part and its function. Icons can help communicate the core idea of your web part simply and boldly.
4141

42-
Web part icons can contain one color or be full color. Most icons work best when using extremely simplified shapes, thin two-pixel lines similar to the Office UI Fabric icons. In some cases there may be a need to use a company brand icon or logo mark in full color. If there is a one color version of the icon available consider using this version first.
42+
Web part icons can contain one color or be full color. Most icons work best when you use simplified shapes, thin two-pixel lines similar to the Office UI Fabric icons. In some cases, you might need to use a company brand icon or logo in full color. If a one-color version of the icon is available, consider using this version.
4343

44-
![One color, two color and full color icon examples](../images/06_Icons_colors.png)
44+
![One color, two color, and full color icon examples](../images/06_Icons_colors.png)
4545

4646
## Exporting your icons
4747

48-
Icons should be exported as SVGs at 64x64 px and should have transparent backgrounds.
48+
Export icons as SVGs at 64x64 px with transparent backgrounds.
4949

5050
You can find the icon grid in the [SharePoint Design toolkit](https://developer.microsoft.com/en-us/fabric#/resources).
5151

docs/design/layout-patterns.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
---
22
title: Layout patterns
3-
description: Common web part layout types and responsive patterns
3+
description: Find common SharePoint web part layout types and responsive patterns.
44
ms.date: 08/24/2018
55
---
66

7-
# Web part layouts
7+
# SharPoint web part layouts
88

9-
SharePoint uses a number of different layout types for web parts. The most commonly used are grid, list, filmstrip, carousel and compact. Each one of these five layouts serves a different purpose depending on a page layout, breakpoints and content density.
9+
SharePoint uses a number of different layout types for web parts. The most common are grid, list, filmstrip, carousel, and compact. Each one of these five layouts serves a different purpose, depending on the layout, breakpoints, and content density of a page.
1010

11-
When selecting a layout that works best for your web part consider the type of content you are displaying. Is it highly visual or rich in text and data. Determine how much space is needed on the page for enough content to be displayed. Consider trucating descriptions that may be lengthy to optimize for displaying more itmes to the end user. Remember that the [property pane](reactive-and-nonreactive-web-parts.md) can be leveraged to let authors have control of how much content is displayed.
11+
When selecting a layout that works best for your web part, consider the type of content you are displaying. Is it highly visual or rich in text and data? Determine how much space is needed on the page for enough content to be displayed. Consider shortening long descriptions to optimize for displaying more itmes to the user. Remember that you can use the [property pane](reactive-and-nonreactive-web-parts.md) to let authors have control over how much content is displayed.
1212

1313
![Carousel with icons representing the common layouts](../images/01_Layouts_webparts.png)
1414

15-
## Grid and Filmstrip
15+
## Grid and filmstrip
1616

17-
Grid and filmstrip layouts are very much alike, they both use cards to showcase content. However, other rectangular content also works well in these layouts such as images. The major difference between the two layouts are how they reflow based on varioius screen sizes or breakpoints.
17+
Grid and filmstrip layouts are similar. They both use cards to showcase content. However, other rectangular content also works well in these layouts, such as images. The main difference between the two layouts is how they reflow based on varioius screen sizes or breakpoints.
1818

1919
### Grid layout
2020

21-
The Grid reflows in rows and columns from top to bottom and can contain a few to many items at a time.
21+
The grid reflows in rows and columns from top to bottom and can contain a few to many items at a time.
2222

2323
![Animated gif showing the Grid layout reflowing across breakpoints](../images/layouts_animation_grid.gif)
2424

2525
### Filmstrip layout
2626

27-
The Filmstrip display multiple items in a single row and caroesels to a new set of items.
27+
The filmstrip displays multiple items in a single row and caoursels to a new set of items.
2828

2929
![Animated gif showing the Filmstrip layout reflowing across breakpoints](../images/layouts_animation_filmstrip.gif)
3030

3131

3232
## List
3333

34-
Using the List layout can be useful to display large amount of info in a compact manner. When resizing the lesser important columns will hide as the page width get smaller.
34+
The list layout is useful for displaying a large amount of information in a compact way. When resized, the less important columns will be hidden as the page width gets smaller.
3535

3636
![Animated gif showing the List layout reflowing across breakpoints](../images/layouts_animation_list.gif)
3737

3838
## Carousel
3939

40-
Want to Showcase content featuring really nice visuals? Go with the Carousel layout. This layout is designed to display visual content such as images, PowerPoint files or simillar in a one by one item carousel.
40+
If you want to showcase content featuring attractive visuals, choose the carousel layout. This layout is designed to display visual content such as images or PowerPoint files in a one-by-one item carousel.
4141

4242
![Animated gif showing the Carousel layout reflowing across breakpoints](../images/layouts_animation_carousel.gif)
4343

4444
## Compact
4545

46-
The Compact layout is designed to show content in a smaller format and works the best in a 1/3rd column. This layout can support a small image or icon and a few rows of text for a title, description and/or metadata.
46+
The compact layout is designed to show content in a smaller format and works the best in a one-third column. This layout can support a small image or icon and a few rows of text for a title, description, and/or metadata.
4747

4848
![Animated gif showing the Compact layout reflowing across breakpoints](../images/layouts_animation_compact.gif)
4949

docs/design/semantic_slots.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: Designing for section backgrounds using semantic slots
3+
description: Learn how to design your web part to take advantage of section backgrounds using semantic slots.
4+
ms.date: 12/06/2018
5+
---
6+
7+
# Overview
8+
9+
When designing web parts for section backgrounds, you can use Office UI Fabric’s semantic slot system to guarantee accessibility and to enforce consistency across SharePoint sites. Semantic slots target customizations of specific page elements in order to align color usage and interaction patterns. They also allow you the flexibility to add or assign multiple palette colors for your components so they look great on all section backgrounds. This article will provide examples for semantic slots and how to incorporate them into your web part designs. Before getting started, you should be familiar with [how to design a SharePoint web part](https://docs.microsoft.com/en-us/sharepoint/dev/design/design-a-web-part) in order to understand the basic structure of web parts. You should also be familiar with [themes and colors in SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/design/themes-colors).
10+
11+
## Section background
12+
13+
Section background is a feature that applies background color to a canvas section on a page. There are four background color options for light and dark themes: None, Neutral, Soft, Strong. Section backgrounds are defined by a Office UI Fabric palette color from a site's theme. With the introduction of the section background feature, semantic slots allow page elements to be accessible on various themes and section backgrounds.
14+
15+
## Variant vs. Section background
16+
17+
A variant describes different values of color generated from an existing theme. A variant will share the same set of colors as the original theme it was generated from, but will apply those colors differently. See [Office UI Fabric variant documentation](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/packages/variants/README.md) for more detail.
18+
19+
A Section Background allows the user to apply a variant color from the theme to a canvas section. Both concepts share "Neutral", "Soft", and "Strong" options and can be used interachangeably when describing color usage.
20+
21+
## Semantic slots
22+
23+
A semantic slot is a theming slot that targets specific page elements. A Office UI Fabric palette color can be assigned to a specific page element without affecting other page elements using the same palette color. When designing for section backgrounds, you can assign a semantic slot a different color for each variant. A semantic slot can have up to eight different values to adapt to each section background option. This helps deliver consistent design patterns throughout various themes and section backgrounds.
24+
25+
For example, default text uses the "bodyText" semantic slot. On the None, Neutral, and Soft section backgrounds, bodyText is assigned neutralPrimary. On the Strong section background, the palette color of bodyText changes to white. Semantic slots can be assigned palette colors for all variants in dark themes as well.
26+
27+
In the table below, you can see all eight palette colors defined for the bodyText slot.
28+
29+
![Example table showing semantic slots on light and dark theme variants](../images/doc-semantic-slot-940px-table.png)
30+
31+
<br/>
32+
<table>
33+
<tr>
34+
<td> </td>
35+
<td> Light themes</td>
36+
<td> Dark themes</td>
37+
</tr>
38+
<tr>
39+
<td>None</td>
40+
<td>neutralPrimary #333333</td>
41+
<td>neutralPrimary #ffffff</td>
42+
</tr>
43+
<tr>
44+
<td>Neutral</td>
45+
<td style="background-color:red">neutralPrimary #333333</td>
46+
<td>neutralPrimary #ffffff</td>
47+
</tr>
48+
<tr>
49+
<td>Soft</td>
50+
<td>neutralPrimary #333333</td>
51+
<td>neutralPrimary #ffffff</td>
52+
</tr>
53+
<tr>
54+
<td>Strong</td>
55+
<td>white #ffffff</td>
56+
<td>white #1f1f1f</td>
57+
</tr>
58+
</table>
59+
<br/>
60+
61+
! Note
62+
The current semantic slot list is defined by commonly used design patterns in SharePoint. We want to avoid creating case-specific semantic slots. When designing a new web part, consider aligning to an existing design pattern. Office UI Fabric's policy is that semantic slots may never be removed from the list, so any additions are permanent.
63+
64+
## Identifying semantic slots in your designs
65+
66+
Semantic slots should be assigned based on the function of a page element. The name of a semantic slot can quickly tell you how it’s meant to be used. You can find all existing semantic slots and their use case examples in the [Fabric semantic colors documentation](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/packages/styling/src/interfaces/ISemanticColors.ts).
67+
68+
Fabric palette colors should be referenced from your site theme’s color ramp. If your site is using a SharePoint out of the box theme, you can reference [SharePoint theme color ramps](https://fluentfabric.azurewebsites.net/#/color/products). If your site is using a custom theme, you can generate a unique color ramp using the [Fabric theme generator](https://developer.microsoft.com/en-us/fabric#/styles/themegenerator).
69+
70+
![Example of redlines for a web part in the None section background](../images/doc-semantic-slot-1.png)
71+
72+
In this example, the semantic slots are referencing palette colors from the None variant. The palette color may change depending on which variant you are using. Typically the variant should correspond with the value of bodyBackground. For example, if the bodyBackground value is "neutralLighter,” your slots should pick up values from the Neutral variant. Fabric palette colors for each variant should correspond with the palette colors listed in the Fabric theme documentation.
73+
74+
## Web part designs with multiple variants
75+
76+
There are instances in which a web part design will use multiple variants. The most common design pattern that uses multiple variants is the card layout. In your designs, you should differentiate which page elements correspond to which variant.
77+
78+
![Example of multiple variant redlines for a web part in the Neutral section background](../images/doc-semantic-slot-2.png)
79+
80+
In this example, all semantic slot redlines in blue are using palette colors defined by the None variant since they sit on the card background. All other content that isn’t on a card uses palette colors from the Neutral variant.

docs/design/themes-colors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.date: 05/21/2018
66

77
# SharePoint themes and colors
88

9-
Like the Microsoft brand palette, the SharePoint themes are designed to build on the Microsoft brand, while at the same time allow for flexibility to enliven our partnerships without dominating them. They reveal our shared goals and personality, and they reflect our diversity and ability to optimize the SharePoint experience.
9+
Like the Microsoft brand palette, the SharePoint themes are designed to build on the Microsoft brand, while at the same time allowing for flexibility to enliven our partnerships without dominating them. They reveal our shared goals and personality, and they reflect our diversity and ability to optimize the SharePoint experience.
1010

1111
## Main colors
1212

docs/design/web-part-levels.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,23 @@ Second-level toolbars within a web part have three core commands: Edit, Move, an
3030

3131
The second-level toolbar should only display when the author selects (clicks/taps) an individual item. Do not show all the second-level toolbars for every items at once, as this can overwhelm the user. Additionally, do not have the toolbar appear on hover, as this might cause usability issues with devices that support touch.
3232

33-
The bounding box and/or outline of each second-level item should change from its default state to the primary color on hover and remain the primary color on selection. It is important that the bounding box and icons keep their active states so the user understands what item is selected when using the property pane or while re-arranging items.
33+
The bounding box and/or outline of each second-level item should change from its default state to the primary color on hover and remain the primary color on selection. It is important that the bounding box and icons keep their active states so the user understands what item is selected when they're using the property pane or while they're rearranging items.
3434

35-
Below is an example from an individual 2nd level item in the Image gallery web part:
35+
The following is an example from an individual second-level item in the Image gallery web part:
3636

37-
Edit Item Level – opens the property pane with specific item level configuration options. Note that the bounding box stays in the active/selected state.
37+
**Edit Item Level** – opens the property pane with specific item-level configuration options. Note that the bounding box stays in the active/selected state.
3838

39-
Move – The transparency of the item drops to 65% and a drop shadow surrounds the item.
39+
**Move** – The transparency of the item drops to 65% and a drop shadow surrounds the item.
4040

41-
Remove – When the X Remove icon is selected the toolbar hides and the item fades out making room for the specific layout to reflow.
41+
**Remove** – When the X Remove icon is selected, the toolbar hides and the item fades out, making room for the specific layout to reflow.
4242

4343
![Selection states of a second level item, example individual image in the Image Gallery web part](../images/03_WebpartLevels_InteractionStates.png)
4444

4545
## Property panes
4646

47-
Property panes work the same on the 2nd item level of a web part as they do when first selecting the entire web part. The focus on the 1st level shifts to the second level selection and allows the author to configure and individual item.
47+
Property panes work the same way on the second item level of a web part that they do when first selecting the entire web part. The focus on the first level shifts to the second level selection and allows the author to configure an individual item.
4848

49-
In the example below the 1st level is the Image source and Layout configuration for the Image gallery web part. When the user selects an individual image they can configure the Title, Caption and Alternative text on the 2nd level property pane.
49+
In the following example, the first level is the Image source and Layout configuration for the Image gallery web part. When the user selects an individual image, they can configure the Title, Caption, and Alternative text on the second-level property pane.
5050

5151
![Property pane comparision between 1st and 2nd level](../images/04_WebpartLevels_PropertyPanes.png)
5252

docs/images/doc-semantic-slot-1.png

124 KB
Loading

docs/images/doc-semantic-slot-2.png

188 KB
Loading
75 KB
Loading

0 commit comments

Comments
 (0)