Skip to content

Commit 9ed8424

Browse files
Merge pull request SharePoint#8174 from dereklh7/Revert-6-13-Design
Validation: Added Missing Alt Text
2 parents 5d6fe74 + 259b739 commit 9ed8424

File tree

4 files changed

+32
-31
lines changed

4 files changed

+32
-31
lines changed

docs/spfx/viva/design/design-intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Design guidance for Viva Connections cards
33
description: Design guidance for Viva Connections cards
4-
ms.date: 12/28/2021
4+
ms.date: 06/27/2022
55
ms.prod: sharepoint
66
ms.localizationpriority: high
77
---
8-
# Designing Viva Connections custom cards for your dashboard
8+
# Design guidance for Viva Connections cards
99

1010
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.
1111

@@ -30,7 +30,7 @@ The cards are designed to enable quick task completion by interacting with a car
3030

3131
## Resources
3232

33-
- [Sample Adaptive Cards for Viva Connections](http://aka.ms/adaptivecards/samples)
33+
- [Sample Adaptive Cards for Viva Connections](https://aka.ms/adaptivecards/samples)
3434
- [Fluent UI](https://developer.microsoft.com/en-us/fluentui#/)
3535
- [Fluent Theme designer](https://fluentuipr.z22.web.core.windows.net/heads/master/theming-designer/index.html)
3636
- [AC Designer](https://adaptivecards.io/designer/)

docs/spfx/viva/design/designing-card.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Dashboard cards design guidance
33
description: Design guidance for the Viva Connections custom cards
4-
ms.date: 12/28/2021
4+
ms.date: 06/13/2022
55
ms.prod: sharepoint
66
ms.localizationpriority: high
77
---
@@ -17,13 +17,13 @@ Cards are used to link resources, surface information, and power direct interact
1717

1818
**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.
1919

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.":::
2121

2222
## Anatomy of cards
2323

2424
Each dashboard card has the following elements:
2525

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.":::
2727

2828
1. **Container**: All card content sits within the container.
2929

@@ -39,7 +39,7 @@ Each dashboard card has the following elements:
3939

4040
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.
4141

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.":::
4343

4444
### Layouts and sizes
4545

@@ -55,19 +55,19 @@ All layouts come in two sizes: medium or large. Card size will determine how the
5555

5656
Use when the heading is sufficient to communicate the key information in the card.
5757

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.":::
5959

6060
#### Heading + Description​​​​​​​
6161

6262
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.
6363

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.":::
6565

6666
### Heading + Image​​​​​​​
6767

6868
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.
6969

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.":::
7171

7272
## Interaction
7373

@@ -77,7 +77,7 @@ There are three possible ways to interact with a card:
7777
- Primary button
7878
- Secondary button
7979

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.":::
8181

8282
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.
8383

@@ -99,28 +99,28 @@ Here are the best practices for designing card interactions:
9999

100100
​​​​​​​Here are some example cards for how these layouts can be used
101101

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.":::
103103

104104

105105
## Platforms and modes
106106

107107
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.
108108

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.":::
110110

111111
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).
112112

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.":::
114114

115115
### Displaying your app in the toolbox
116116

117117
New cards are added to that dashboard using the following toolbox.
118118

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.":::
120120

121121
To display your custom app in the dashboard picker, you will need the following:
122122

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.":::
124124

125125
**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).
126126

@@ -132,7 +132,7 @@ To display your custom app in the dashboard picker, you will need the following:
132132

133133
When the app is clicked, the card is displayed on the dashboard. The card can be edited using the settings panel on the right.
134134

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.":::
136136

137137
Here are some best practices for offering customization settings:
138138

docs/spfx/viva/design/designing-quick-view.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Quick view design guidance
33
description: Design guidance for the Viva Connections quick views
4-
ms.date: 12/28/2021
4+
ms.date: 06/13/2022
55
ms.prod: sharepoint
66
ms.localizationpriority: high
77
---
@@ -13,7 +13,7 @@ Create quick views to provide a bit more detailed information (for example: a de
1313

1414
Here are a few examples of quick views:
1515

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.":::
1717

1818
> [!TIP]
1919
> 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
2525
2626
## Layout
2727

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.":::
2929

3030
1. Header
3131
1. Dismiss quick view
@@ -62,13 +62,13 @@ Avoid adding too many navigation levels within the Quick view. It's best to keep
6262

6363
While you can open several children quick views from the parent quick view, we recommend not to navigate more than one level down.
6464

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.":::
6666

6767
### Quick views vs Web views
6868

6969
Despite being visually similar, they are two different surfaces for different use cases.
7070

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.":::
7272

7373
#### Quick view
7474

@@ -86,13 +86,13 @@ Any web page opened on mobile is going to be rendered within a web view, while i
8686

8787
Quick views will follow SharePoint default and custom company-created themes.
8888

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.":::
9090

9191
### Mobile
9292

9393
Currently dark themes are not supported for quick views on iOS and Android mobile.
9494

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.":::
9696

9797
### Behavior for links and Single sign-on
9898
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)

docs/spfx/viva/design/quick-view-samples.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Viva Connections Adaptive Card Extension Quick View samples
3-
ms.date: 2/10/2022
3+
description: Provides Viva Connections Adaptive Card extension Quick View samples and outlines various GitHub samples for Quick View templates.
4+
ms.date: 06/13/2022
45
ms.prod: sharepoint
56
ms.localizationpriority: high
67
---
@@ -50,39 +51,39 @@ Design for presenting inventory details from warehouse.
5051

5152
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/inventory)
5253

53-
:::image type="content" source="../../../images/viva-design/samples/inventory.png" alt-text="Inventory":::
54+
:::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.":::
5455

5556
## Payslip
5657

5758
Design for showing payslip details in adaptive card format.
5859

5960
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/payslip)
6061

61-
:::image type="content" source="../../../images/viva-design/samples/payslip.png" alt-text="Payslip":::
62+
:::image type="content" source="../../../images/viva-design/samples/payslip.png" alt-text="Screenshot of payslip details populating in an adaptive card format.":::
6263

6364
## Simple list with praise information
6465

6566
Design for showing simple list of people in praise scenario.
6667

6768
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/simple-list)
6869

69-
:::image type="content" source="../../../images/viva-design/samples/praise.png" alt-text="Praise":::
70+
:::image type="content" source="../../../images/viva-design/samples/praise.png" alt-text="Screenshot of a card reading Send praise to your colleagues.":::
7071

7172
## Team calendar
7273

7374
Design for showing calendar format and upcoming team events.
7475

7576
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/team-calendar)
7677

77-
:::image type="content" source="../../../images/viva-design/samples/teamcalendar.png" alt-text="Praise":::
78+
:::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.":::
7879

7980
## Timeline events
8081

8182
Design for showing a timeline with upcoming events.
8283

8384
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/timeline-holidays)
8485

85-
:::image type="content" source="../../../images/viva-design/samples/holidays.png" alt-text="Holidays":::
86+
:::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.":::
8687

8788
## Vacation / time off
8889

@@ -98,7 +99,7 @@ Design for booking vaccination booster appointment with images and a submission
9899

99100
* Sample at [GitHub](https://github.com/pnp/AdaptiveCards-Templates/tree/main/samples/vaccination-booster)
100101

101-
:::image type="content" source="../../../images/viva-design/samples/vaccination.png" alt-text="Vaccination":::
102+
:::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.":::
102103

103104
## Visual list with cafeteria menu scenario
104105

0 commit comments

Comments
 (0)