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/designing-card.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -17,25 +17,25 @@ 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-design.gif" alt-text="Card container and elements":::
20
+
:::image type="content" source="../../../images/viva-design/img-card-design2.gif" alt-text="Card container and elements":::
21
21
22
22
## Anatomy of cards
23
23
24
24
Each dashboard card has the following elements:
25
25
26
26
:::image type="content" source="../../../images/viva-design/img_card_base.jpg" alt-text="Card container and elements":::
27
27
28
-
1. Container: All card content sits within the container.
28
+
1.**Container**: All card content sits within the container.
29
29
30
-
1. Icon: Unique visual representation of this card. You can choose the icon from the pre-defined set or upload a customized icon.
30
+
1.**Icon**: Unique visual representation of this card. You can choose the icon from the pre-defined set or upload a customized icon.
31
31
32
-
Icons from the pre-defined set are theme-friendly and will automatically adjust to light and dark themes using theme primary color.
32
+
Icons from the pre-defined set are theme-friendly and will automatically adjust to light and dark themes using theme primary color.
33
33
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.
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.
35
35
36
-
1. Title: Typically the app name. All titles should be in sentence case.
36
+
1.**Title**: Typically the app name. All titles should be in sentence case.
37
37
38
-
1. Heading: Most visually prominent text on the card. Used to communicate key information. Heading text can be static or dynamically updated. All headings should be in sentence case.
38
+
1.**Heading**: Most visually prominent text on the card. Used to communicate key information. Heading text can be static or dynamically updated. All headings should be in sentence case.
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
@@ -108,7 +108,7 @@ Dashboard cards are supported on iOS, Android, and Web. However there are slight
108
108
109
109
:::image type="content" source="../../../images/viva-design/img_card_platforms.jpg" alt-text="Card container and elements":::
110
110
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.
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
113
:::image type="content" source="../../../images/viva-design/img_card_modes.jpg" alt-text="Card container and elements":::
114
114
@@ -122,11 +122,11 @@ To display your custom app in the dashboard picker, you will need the following:
122
122
123
123
:::image type="content" source="../../../images/viva-design/img_card_toolbox2.jpg" alt-text="Card container and elements":::
124
124
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).
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
127
-
**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.
127
+
**2. 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.
128
128
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.
129
+
**3. 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.
0 commit comments