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/spfx/viva/design/design-intro.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
title: Design guidance for Viva Connections cards
3
3
description: Design guidance for Viva Connections cards
4
-
ms.date: 12/28/2021
4
+
ms.date: 06/27/2022
5
5
ms.prod: sharepoint
6
6
ms.localizationpriority: high
7
7
---
8
-
# Designing Viva Connections custom cards for your dashboard
8
+
# Design guidance for Viva Connections cards
9
9
10
10
Developers can extend [Microsoft Viva Connections](https://www.microsoft.com/microsoft-viva) for building engaging experiences with the widely adopted SharePoint Framework (SPFx). Viva Connections is your gateway to a modern employee experience where you can build and integrate apps that shape culture and foster connections to help employees thrive. With SPFx, you have multiple ways to extend – using the same out-of-the-box or custom SPFx web parts, SPFx extensions (for example header, footer), and specific components for optimized mobile experiences.
11
11
@@ -30,7 +30,7 @@ The cards are designed to enable quick task completion by interacting with a car
30
30
31
31
## Resources
32
32
33
-
-[Sample Adaptive Cards for Viva Connections](http://aka.ms/adaptivecards/samples)
33
+
-[Sample Adaptive Cards for Viva Connections](https://aka.ms/adaptivecards/samples)
Copy file name to clipboardExpand all lines: docs/spfx/viva/design/designing-card.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Dashboard cards design guidance
3
3
description: Design guidance for the Viva Connections custom cards
4
-
ms.date: 12/28/2021
4
+
ms.date: 06/13/2022
5
5
ms.prod: sharepoint
6
6
ms.localizationpriority: high
7
7
---
@@ -17,13 +17,13 @@ Cards are used to link resources, surface information, and power direct interact
17
17
18
18
**Bring cards to life with relevant and dynamically refreshable data:** Company stock price, due dates for training or projects, task assignment updates, and remaining vacation days are some examples.
19
19
20
-
:::image type="content" source="../../../images/viva-design/img-card-design2.gif" alt-text="Card container and elements":::
20
+
:::image type="content" source="../../../images/viva-design/img-card-design2.gif" alt-text="Moving image that shows process of clocking in for a shift.":::
21
21
22
22
## Anatomy of cards
23
23
24
24
Each dashboard card has the following elements:
25
25
26
-
:::image type="content" source="../../../images/viva-design/img_card_base.jpg" alt-text="Card container and elements":::
26
+
:::image type="content" source="../../../images/viva-design/img_card_base.jpg" alt-text="Diagram showing the card container and card elements, showing the Time off and paid time off available options.":::
27
27
28
28
1.**Container**: All card content sits within the container.
29
29
@@ -39,7 +39,7 @@ Each dashboard card has the following elements:
39
39
40
40
When adding the title and heading, ensure the text does not truncate and can fit in the card width on both desktop and mobile in both card sizes (more information about sizes is given below) and all languages used. Truncated text can hide key information that might be necessary for the end user to complete the task. For the title, in most cases, a length of 10-12 characters should fit the card width well.
41
41
42
-
:::image type="content" source="../../../images/viva-design/img_card_truncation.jpg" alt-text="Card container and elements":::
42
+
:::image type="content" source="../../../images/viva-design/img_card_truncation.jpg" alt-text="Diagram that shows the submit time of and Time off options, with the Time off option being the recommended option.":::
43
43
44
44
### Layouts and sizes
45
45
@@ -55,19 +55,19 @@ All layouts come in two sizes: medium or large. Card size will determine how the
55
55
56
56
Use when the heading is sufficient to communicate the key information in the card.
57
57
58
-
:::image type="content" source="../../../images/viva-design/img_card_heading.jpg" alt-text="Card container and elements":::
58
+
:::image type="content" source="../../../images/viva-design/img_card_heading.jpg" alt-text="Diagram of the Time Off task and shows the Heading relationship between the two tasks.":::
59
59
60
60
#### Heading + Description
61
61
62
62
Use when the description can add informational value to the heading and can make it easier to understand the purpose of the card. Avoid repeating information already communicated in the heading.
63
63
64
-
:::image type="content" source="../../../images/viva-design/img_card_description.jpg" alt-text="Card container and elements":::
64
+
:::image type="content" source="../../../images/viva-design/img_card_description.jpg" alt-text="Diagram of the two Time Off tasks and showing the Heading and Description for Medium and Large tasks.":::
65
65
66
66
### Heading + Image
67
67
68
68
Images draw viewer's eye, so use images carefully either to create recognition of a familiar app or website, or increase overall visual prominence of the card on the dashboard. The image should meaningfully connect to the heading and/or title.
69
69
70
-
:::image type="content" source="../../../images/viva-design/img_card_image.jpg" alt-text="Card container and elements":::
70
+
:::image type="content" source="../../../images/viva-design/img_card_image.jpg" alt-text="Screenshot of the medium and large icons showing how an image appears for the medium card layout versus how it appears for the large card layout.":::
71
71
72
72
## Interaction
73
73
@@ -77,7 +77,7 @@ There are three possible ways to interact with a card:
77
77
- Primary button
78
78
- Secondary button
79
79
80
-
:::image type="content" source="../../../images/viva-design/img_card_interactions.jpg" alt-text="Card container and elements":::
80
+
:::image type="content" source="../../../images/viva-design/img_card_interactions.jpg" alt-text="Screenshot of the card, primary button, and secondary button interactions.":::
81
81
82
82
Each of these interactions can be customized. Use these to perform an instant action, send a request to server, open a quick view (add link), link to a Teams app, open an external website and so on.
83
83
@@ -99,28 +99,28 @@ Here are the best practices for designing card interactions:
99
99
100
100
Here are some example cards for how these layouts can be used
101
101
102
-
:::image type="content" source="../../../images/viva-design/img_card_collections.jpg" alt-text="Card container and elements":::
102
+
:::image type="content" source="../../../images/viva-design/img_card_collections.jpg" alt-text="Screenshot showing various example cards, including cards for Shifts, Tasks, COVID 19, and Tutorials.":::
103
103
104
104
105
105
## Platforms and modes
106
106
107
107
Dashboard cards are supported on iOS, Android, and Web. However there are slight differences the styling between different platforms – fonts (Segoe UI for desktop, Roboto for Android, SF Display Pro for iOS), colors, sizes, and spacing is slightly tweaked to better suit the respective platform and make the cards look consistent with the overall experience of that platform.
108
108
109
-
:::image type="content" source="../../../images/viva-design/img_card_platforms.jpg" alt-text="Card container and elements":::
109
+
:::image type="content" source="../../../images/viva-design/img_card_platforms.jpg" alt-text="Screenshot showing how the same card appears on web, i O S, and Android platforms.":::
110
110
111
111
Dashboard cards also support both light and dark mode theme. Ensure that colors you use work for both modes – text should be legible, and buttons and icons should be clearly recognizable against the background. To meet accessibility criteria, text should have a color ratio of 4.5:1 against the button background, and non-text components like icon should have a color ratio of 3:1 against the background. [Use this tool to check color contrast](https://fluentuipr.z22.web.core.windows.net/heads/master/theming-designer/index.html).
112
112
113
-
:::image type="content" source="../../../images/viva-design/img_card_modes.jpg" alt-text="Card container and elements":::
113
+
:::image type="content" source="../../../images/viva-design/img_card_modes.jpg" alt-text="Screenshot that shows how the same card appears in light mode versus how it appears in dark mode.":::
114
114
115
115
### Displaying your app in the toolbox
116
116
117
117
New cards are added to that dashboard using the following toolbox.
118
118
119
-
:::image type="content" source="../../../images/viva-design/img_card_toolbox.jpg" alt-text="Card container and elements":::
119
+
:::image type="content" source="../../../images/viva-design/img_card_toolbox.jpg" alt-text="Screenshot of the Relecloud screen showing the Dashboard, which displays various tools.":::
120
120
121
121
To display your custom app in the dashboard picker, you will need the following:
122
122
123
-
:::image type="content" source="../../../images/viva-design/img_card_toolbox2.jpg" alt-text="Card container and elements":::
123
+
:::image type="content" source="../../../images/viva-design/img_card_toolbox2.jpg" alt-text="Screenshot of the dashboard with a focus on the icon, title, and descriptive text for each tool in the dashboard.":::
124
124
125
125
**1. Icon:** Unique visual representation of this app. Your custom icon maximum size is 24 px by 24 px and should preferably in PNG or SVG format. SVG icons scale better across different screen resolutions. It is preferable to use a monochromatic icon, but you can use color icons if you want to represent your unique brand with the icons. Either way, make sure the icon has a transparent background, and it looks good both on light and dark theme. [Learn about SharePoint themes](/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview). The same icon is to be used for the dashboard card (see above).
126
126
@@ -132,7 +132,7 @@ To display your custom app in the dashboard picker, you will need the following:
132
132
133
133
When the app is clicked, the card is displayed on the dashboard. The card can be edited using the settings panel on the right.
134
134
135
-
:::image type="content" source="../../../images/viva-design/img_card_settings.jpg" alt-text="Card container and elements":::
135
+
:::image type="content" source="../../../images/viva-design/img_card_settings.jpg" alt-text="Screenshot of the Rerecloud application showing an edit pane that allows the user to edit the title, heading, and description of a card.":::
136
136
137
137
Here are some best practices for offering customization settings:
Copy file name to clipboardExpand all lines: docs/spfx/viva/design/designing-quick-view.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Quick view design guidance
3
3
description: Design guidance for the Viva Connections quick views
4
-
ms.date: 12/28/2021
4
+
ms.date: 06/13/2022
5
5
ms.prod: sharepoint
6
6
ms.localizationpriority: high
7
7
---
@@ -13,7 +13,7 @@ Create quick views to provide a bit more detailed information (for example: a de
13
13
14
14
Here are a few examples of quick views:
15
15
16
-
:::image type="content" source="../../../images/viva-design/img_quickviews.jpg" alt-text="Card container and elements":::
16
+
:::image type="content" source="../../../images/viva-design/img_quickviews.jpg" alt-text="Screenshot of various examples of quick views.":::
17
17
18
18
> [!TIP]
19
19
> Sample adaptive card designs for the quick views are available from [GitHub](https://github.com/pnp/AdaptiveCards-Templates)
@@ -25,7 +25,7 @@ The Quick View experience works across different platforms and form-factors base
25
25
26
26
## Layout
27
27
28
-
:::image type="content" source="../../../images/viva-design/img_quickview_layout.jpg" alt-text="Card container and elements":::
28
+
:::image type="content" source="../../../images/viva-design/img_quickview_layout.jpg" alt-text="Screenshot of a card with a focus on the header and content area, which includes containers, elements, and inputs.":::
29
29
30
30
1. Header
31
31
1. Dismiss quick view
@@ -62,13 +62,13 @@ Avoid adding too many navigation levels within the Quick view. It's best to keep
62
62
63
63
While you can open several children quick views from the parent quick view, we recommend not to navigate more than one level down.
64
64
65
-
:::image type="content" source="../../../images/viva-design/img_quickview_backstack.gif" alt-text="Card container and elements":::
65
+
:::image type="content" source="../../../images/viva-design/img_quickview_backstack.gif" alt-text="Moving image of accessing the registration form task which leads to the registration F A Q card.":::
66
66
67
67
### Quick views vs Web views
68
68
69
69
Despite being visually similar, they are two different surfaces for different use cases.
70
70
71
-
:::image type="content" source="../../../images/viva-design/img_quickview_webview.jpg" alt-text="Card container and elements":::
71
+
:::image type="content" source="../../../images/viva-design/img_quickview_webview.jpg" alt-text="Screenshot of the registration form card and of a web browser tab of Microsoft dot com.":::
72
72
73
73
#### Quick view
74
74
@@ -86,13 +86,13 @@ Any web page opened on mobile is going to be rendered within a web view, while i
86
86
87
87
Quick views will follow SharePoint default and custom company-created themes.
88
88
89
-
:::image type="content" source="../../../images/viva-design/img_quickview_web_theme.jpg" alt-text="Card container and elements":::
89
+
:::image type="content" source="../../../images/viva-design/img_quickview_web_theme.jpg" alt-text="Screenshot that shows how a card viewed on webpages appears in light mode and dark mode.":::
90
90
91
91
### Mobile
92
92
93
93
Currently dark themes are not supported for quick views on iOS and Android mobile.
94
94
95
-
:::image type="content" source="../../../images/viva-design/img_quickview_ios_theme.jpg" alt-text="Card container and elements":::
95
+
:::image type="content" source="../../../images/viva-design/img_quickview_ios_theme.jpg" alt-text="Screenshot that shows how a card viewed on mobile appears in light mode and dark mode.":::
96
96
97
97
### Behavior for links and Single sign-on
98
98
For some cards, you will use links to URLs. Depending on the ___location of the content, links to URLs may display content in Microsoft Teams or elsewhere and Single sign-on (SSO) behavior can differ. Get more information about how links to URLs and SSO behave depending on the ___location of the content you are linking to. [Learn more](/viva/connections/create-dashboard.md#how-urls-and-single-sign-on-works)
:::image type="content" source="../../../images/viva-design/samples/inventory.png" alt-text="Screenshot of a sample inventory details card from a warehouse, showing Distribution center number 73's top selling items.":::
54
55
55
56
## Payslip
56
57
57
58
Design for showing payslip details in adaptive card format.
58
59
59
60
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/payslip)
:::image type="content" source="../../../images/viva-design/samples/payslip.png" alt-text="Screenshot of payslip details populating in an adaptive card format.":::
62
63
63
64
## Simple list with praise information
64
65
65
66
Design for showing simple list of people in praise scenario.
66
67
67
68
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/simple-list)
:::image type="content" source="../../../images/viva-design/samples/praise.png" alt-text="Screenshot of a card reading Send praise to your colleagues.":::
70
71
71
72
## Team calendar
72
73
73
74
Design for showing calendar format and upcoming team events.
74
75
75
76
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/team-calendar)
:::image type="content" source="../../../images/viva-design/samples/teamcalendar.png" alt-text="Screenshot of the sample team calendar, showing upcoming team events for October 2021.":::
78
79
79
80
## Timeline events
80
81
81
82
Design for showing a timeline with upcoming events.
82
83
83
84
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/timeline-holidays)
:::image type="content" source="../../../images/viva-design/samples/holidays.png" alt-text="Screenshot of a sample timeline event card, showing the Thanksgiving and Christmas Eve events in 2021.":::
86
87
87
88
## Vacation / time off
88
89
@@ -98,7 +99,7 @@ Design for booking vaccination booster appointment with images and a submission
98
99
99
100
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/vaccination-booster)
:::image type="content" source="../../../images/viva-design/samples/vaccination.png" alt-text="Screenshot of the Living Well Health Center and Pharmacy providing information on scheduling a free COVID-19 booster appointment.":::
0 commit comments