Skip to content

Commit 19cb5ef

Browse files
committed
Adding draft design guidance doc for Viva ACEs
1 parent 6da341c commit 19cb5ef

File tree

1 file changed

+147
-0
lines changed

1 file changed

+147
-0
lines changed
Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: Designing custom cards for your dashboard
3+
description: Design guidance for the Viva Connections custom cards
4+
ms.date: 10/18/2021
5+
ms.prod: sharepoint
6+
ms.localizationpriority: high
7+
---
8+
# Designing Viva Connections custom cards for your dashboard
9+
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 (e.g. header, footer), and specific components for optimized mobile experiences.
11+
12+
[!INCLUDE [spfx-release-beta](../../../includes/snippets/spfx-release-beta.md)]
13+
14+
## Overview
15+
16+
### Intro
17+
18+
Use this toolkit to help you design custom cards for your dashboard. You'll learn the structure of cards, how users can interact with them, and the design principles to help you make them attractive and engaging for mobile and desktop use.
19+
20+
To learn more about how to create custom cards, see Getting Started - Adaptive Cards
21+
22+
### What is a Dashboard?
23+
24+
The Viva Connections Dashboard is the digital toolbelt for your employees. You can create a curated experience using dashboard cards to give your employees access to their most critical content and tools.
25+
26+
The cards are designed to enable quick task completion by interacting with a card directly or by opening a quick view.
27+
28+
[image dashboard_overview.jpg]
29+
30+
31+
## Interactions Flow
32+
33+
### Structure
34+
35+
Cards, Quick View
36+
37+
[image Card + Quick view]
38+
39+
### User Interaction principles
40+
41+
Provide a simple flow that allows users to accomplish tasks quickly.
42+
Reflect dynamic content that refreshes based on a user action.
43+
Display a quick view with more information or an input form.
44+
Maintain consistency between the card and its quick view.
45+
46+
[image ia_schema.jpg]
47+
48+
## Components
49+
50+
### Cards
51+
52+
#### Principles
53+
54+
Create cards that connect and engage employees with organization content and tasks.
55+
56+
Integrate rather than duplicate. Take advantage of the experiences already available on your intranet, such as task assignments and completion, shift schedules, company policies, and more.
57+
58+
Stay in context. Design cards to avoid making users jump around to different experiences. For example, it's ideal if you can keep interactions within the Viva Connections app using Quick view. Next best is to keep user interactions within Teams.
59+
60+
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.
61+
62+
#### Sizes (specs)
63+
64+
You can choose from medium or large card sizes. Card size will determine how the space in the dashboard is utilized. It's useful to start with medium size cards and then try out large as your dashboard comes together.
65+
66+
[image two_cards.jpg]
67+
68+
#### Layouts (anatomy)
69+
70+
Setting buttons aside, there are three possible card layouts to choose from: Heading, dynamic value + heading and Image + heading
71+
72+
> [!NOTE]
73+
> Image and heading layout does not have buttons with M size cards due to lack of space.
74+
75+
[image card_layouts.jpg]
76+
77+
#### Interaction
78+
79+
Each card must be linked to a destination like a SharePoint page, a web site, or an app.
80+
81+
Buttons are either filled or outlined. Filled represents a user action, while outlined opens a Quick view.
82+
83+
[image card_patterns.jpg]
84+
85+
#### States
86+
87+
[image card_states.jpg]
88+
89+
#### Examples (collections)
90+
91+
[image card_collections.jpg]
92+
93+
### Quick view
94+
95+
#### Principles
96+
97+
Use Quick view to do things like present details or more information, or to provide users a way to accomplish tasks without opening a separate app.
98+
99+
Avoid adding too many navigation levels within the Quick view. It's best to keep it simple so that it's easy for users to accomplish their task quickly.
100+
101+
#### Back stack
102+
103+
While theoretically you can open several children quick views from the parent quick view, we recommend not to navigate more than one level down.
104+
105+
[image qv_backstack.jpg]
106+
107+
#### Implementing Quick View experiences
108+
109+
The Quick View experience works across platforms and form-factors based on a single JSON. This introduces significant limitations in terms of styling and placement on controls and how they show up on mobile devices. There are also styling issues which may be on mobile form factor and may not be there in web or vice versa.
110+
111+
#### Out of the box controls
112+
113+
## Platforms & Theming
114+
115+
Design for different screens, platforms, and colors.
116+
117+
[image web_ios_android.jpg]
118+
119+
### Platforms
120+
121+
The dashboard can be viewed on a mobile device: iOS / Android or in a browser: SharePoint page.
122+
123+
The stylistic differences are fairly minimal and adhere to Microsoft Fluent language (see Resources page for more details). To quickly call out just a few main ones: different font families Segoe UI, SF Display Pro, and Roboto and font sizes.
124+
125+
[image cards_platforms.jpg]
126+
127+
Devices Examples: iOS/Android, Web
128+
129+
### Theming
130+
131+
When designing for light and dark themes, keep in mind the following:
132+
133+
- Colors from your SharePoint intranet theme are automatically applied.
134+
- Use monochrome SVG icons so that they are automatically colored based on your SharePoint intranet theme.
135+
- Check that your images are visible and work well on light and dark backgrounds.
136+
137+
> [!NOTE]
138+
> Note: Quick view currently supports only a light theme.
139+
140+
[image light_dark.jpg]
141+
142+
143+
## Resources
144+
145+
- [Fluent UI](https://developer.microsoft.com/en-us/fluentui#/)
146+
- [Fluent Theme designer](https://fluentuipr.z22.web.core.windows.net/heads/master/theming-designer/index.html)
147+
- [AC Designer](https://adaptivecards.io/designer/)

0 commit comments

Comments
 (0)