Skip to content

Commit d4868a0

Browse files
committed
Wording updates on ACE design guidance
1 parent 3c29719 commit d4868a0

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Each dashboard card has the following elements:
3131

3232
Icons from the pre-defined set are theme-friendly and will automatically adjust to light and dark themes using theme primary color.
3333

34-
For customized icons, maximum size is 24px by 24px. Recommended formats are PNG or SVG. SVG icons scale better across different screen resolutions. Please make sure the icon has a transparent background, and it looks good both on light and dark theme. Learn about SharePoint themes.
34+
For customized icons, maximum size is 24 px by 24 px. Recommended formats are PNG or SVG. SVG icons scale better across different screen resolutions. Make sure the icon has a transparent background, and it looks good both on light and dark theme. Learn about SharePoint themes.
3535

3636
1. Title: Typically the app name. All titles should be in sentence case.
3737

@@ -49,7 +49,7 @@ There are three types of cards layouts available to choose from.
4949
- Heading + Image
5050
- Heading + Description
5151

52-
All layouts come in two sizes: medium or large. Card size will determine how the space in the dashboard is utilized. It's useful to start with medium size cards. Try and use large size card if they are needed to showcase additional info that does not fit in the medium size.
52+
All layouts come in two sizes: medium or large. Card size will determine how the space in the dashboard is utilized. It's useful to start with medium size cards. Use large size card if they are needed to showcase additional info that does not fit in the medium size.
5353

5454
#### Heading​​​​​​​
5555

@@ -86,7 +86,7 @@ Here are the best practices for designing card interactions:
8686
- The overall card should always be interactive.
8787
- If the primary button is used, because of its visual prominence, it should be the most important action on the card.
8888
- The secondary button can used either on its own or in conjunction with the primary button if two actions are needed (only available in large size card layouts). If it's used with the primary button, make sure it is linked to the second most important action on the card. In that case, the card itself will become the least important action.
89-
- For button labels, use concise and clear text that accurately reflects button behavior. Eg. 'View tasks' can better than only 'View'.
89+
- For button labels, use concise and clear text that accurately reflects button behavior. For example 'View tasks' can better than only 'View'.
9090
- Make sure each interaction on the card is unique.
9191
- 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 the dashboard.
9292

@@ -104,7 +104,7 @@ Here are the best practices for designing card interactions:
104104

105105
## Platforms and modes
106106

107-
Dashboard cards are supported on iOS, Android, and Web. However, note that 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.
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.
108108

109109
:::image type="content" source="../../../images/viva-design/img_card_platforms.jpg" alt-text="Card container and elements":::
110110

@@ -122,11 +122,11 @@ To display your custom app in the dashboard picker, you will need the following:
122122

123123
:::image type="content" source="../../../images/viva-design/img_card_toolbox2.jpg" alt-text="Card container and elements":::
124124

125-
**1. Icon:** Unique visual representation of this app. Your custom icon be a maximum size is 24px by 24px 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 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.. The same icon is to be used for the dashboard card (see above).
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.. The same icon is to be used for the dashboard card (see above).
126126

127127
**1. Title:** Make sure the title of the app is concise and is not truncated. Recommended length is 10-12 characters. The same title should be used for the dashboard card (see above) and the quick view (link quick view page) (if used). If you have multiple apps, it is recommended that each app has a unique title. All titles should be sentence case.
128128

129-
**1. Descriptive text:** A clear, concise description explains the purpose of the card and provides information about how to use it. It should show up in the tooltip on hover (in web). Make sure the text wraps appropriately and is not too wide or too narrow in the tooltip. The optimal line length for is considered to be 50-60 characters per line, including spaces.
129+
**1. Descriptive text:** A clear, concise description explains the purpose of the card and provides information about how to use it. It should show up in the tooltip on hover (in web). Make sure the text wraps appropriately and is not too wide or too narrow in the tooltip. The optimal line length is considered to be 50-60 characters per line, including spaces.
130130

131131
### Defining settings for the card
132132

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Here are a few examples of quick views:
1515

1616
:::image type="content" source="../../../images/viva-design/img_quickviews.jpg" alt-text="Card container and elements":::
1717

18+
> [!TIP]
19+
> Sample adaptive card designs for the quick views are available from [GitHub](https://github.com/pnp/AdaptiveCards-Templates)
20+
1821
The Quick View experience works across different platforms and form-factors based on a single JSON. This introduces certain limitations in terms of available styling and placement on controls. You should not expect identical or pixel perfect comparison of a quick view rendered on web / iOS or Android.
1922

2023
> [!TIP]
@@ -63,7 +66,7 @@ While you can open several children quick views from the parent quick view, we r
6366

6467
### Quick views vs Web views
6568

66-
Despite being visually similar, they are two very different surfaces for different use cases.
69+
Despite being visually similar, they are two different surfaces for different use cases.
6770

6871
:::image type="content" source="../../../images/viva-design/img_quickview_webview.jpg" alt-text="Card container and elements":::
6972

0 commit comments

Comments
 (0)