Skip to content

Commit 5b025aa

Browse files
committed
Update interface guidelines
1 parent c65d1df commit 5b025aa

File tree

4 files changed

+32
-14
lines changed

4 files changed

+32
-14
lines changed

apps/docs/content/components/Card/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Cards should always be used in groups of two or more related concepts.
3030

3131
### Stacked
3232

33-
Cards should be stacked to display a list of items that are related to each other. If displaying a visual asset, do so for all cards to achieve a visually balanced layout. The visual asset should be the same type for all cards, either an icon or an image.
33+
Cards should be stacked to display a list of items that are related to each other. When displaying a visual asset, ensure it is consistent across all cards to create a visually balanced layout. The visual asset should be the same type for each card, either an icon or an image.
3434

3535
For a better visual experience, we recommend using similar length size for the heading and description in all stacked cards.
3636

@@ -123,7 +123,7 @@ The call to action label indicates the action or resource the card links to. It
123123

124124
### Border
125125

126-
Card offers a variation with a border. Border is disabled by default.
126+
Card offers a variation with a border. Border is disabled by default.
127127

128128
## Related components
129129

476 KB
Loading
400 KB
Loading

apps/docs/content/components/Pillar/index.mdx

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: Use the pillar component to group related content together.
44
---
55

66
import ComponentLayout from '../../../src/layouts/component-layout'
7+
import doStackImages from './images/do-stack-images.png'
8+
import dontStackImages from './images/dont-stack-images.png'
9+
710
export default ComponentLayout
811

912
## Anatomy
@@ -17,34 +20,35 @@ export default ComponentLayout
1720

1821
## Usage
1922

20-
Use pillars to group similar features or benefits together to easily scan and read. Pillars display content in a familiar and recognizable style.
23+
Use pillars to display a collection of features or benefits, making them easier to scan and read. Pillars present content in a familiar and recognizable style.
2124

2225
### Stacked
2326

24-
Pillars should be stacked to display a list of items that are related to each other. Use consistent pillar sizes within a row or group. A group or a row of content pillars is more visually appealing when the widths and heights of all elements match, so keep the content lenght of each pillar consistent.
27+
Stack multiple pillars to create a collection of items. Ensure that all the items in a group have consistent content lengths so that their width and height match, making the content more visually appealing. When displaying a visual, create a balanced layout by using the same type for each pillar, either an icon or an image.
2528

2629
<DoDontContainer>
2730
<Do>
2831
<img src="https://github.com/primer/brand/assets/912236/cd9679ab-cfa0-4c6d-8a55-21d16668f1ca" />
2932
<Caption>
30-
Use a similar content size to achieve a visually balanced layout.
33+
Use similar content lengths to achieve a visually balanced layout.
3134
</Caption>
3235
</Do>
3336
<Dont>
3437
<img src="https://github.com/primer/brand/assets/912236/cd6e471f-98cf-4c70-801f-c0aeb4d2bdf5" />
3538
<Caption>
36-
Don't use different length sizes for the title or the description.
39+
Avoid varying content lengths for the title and description.
3740
</Caption>
3841
</Dont>
3942
</DoDontContainer>
4043

41-
If displaying an icon, do so for all cards to achieve a visually balanced layout.
44+
Use pillars with images only for groups of a maximum of three to six items. Avoid stacking multiple sections that each contain groups of six pillars.
4245

4346
<DoDontContainer>
4447
<Do>
4548
<img src="https://github.com/primer/brand/assets/912236/cdceda67-a911-40a0-839a-4620c83fe510" />
4649
<Caption>
47-
Use icons either for all pillars or none for a visually balanced layout.
50+
When using icons, add them to all pillars to create a visually balanced
51+
layout.
4852
</Caption>
4953
</Do>
5054
<Dont>
@@ -53,9 +57,23 @@ If displaying an icon, do so for all cards to achieve a visually balanced layout
5357
</Dont>
5458
</DoDontContainer>
5559

56-
When presenting more than four pillars, we recommend displaying them in multiple rows. You can use the [Grid](/components/Grid) or the [Stack](/components/Stack) component to achieve this. We recommend using a grid with 3 or 4 columns and balancing the number of pillars on each row.
60+
<DoDontContainer>
61+
<Do>
62+
<img alt="" src={doStackImages} />
63+
<Caption>
64+
When using images, add them to all pillars to create a visually balanced
65+
layout.
66+
</Caption>
67+
</Do>
68+
<Dont>
69+
<img alt="" src={dontStackImages} />
70+
<Caption>Don't use images with different aspect ratios.</Caption>
71+
</Dont>
72+
</DoDontContainer>
73+
74+
When presenting more than four pillars, we recommend displaying them in multiple rows. You can use the [Grid](/components/Grid) or the [Stack](/components/Stack) component to achieve this. We recommend using a grid with three or four columns and balancing the number of pillars on each row.
5775

58-
![An image showing a group of numerous Pillars stacked in a 3 column grid.](https://github.com/primer/brand/assets/912236/350c5eab-bd21-450c-a7a3-60e29c828a3f)
76+
![An image showing a group of numerous Pillars stacked in a three column grid.](https://github.com/primer/brand/assets/912236/350c5eab-bd21-450c-a7a3-60e29c828a3f)
5977

6078
### Pillar and Card
6179

@@ -71,18 +89,18 @@ Cards should be used for noteworthy information to immediately draw user attenti
7189

7290
#### Group size
7391

74-
Cards should be used in small groups (3, 4 or 5 items maximum), whereas Pillars can be used in larger (more than 5 items) or smaller groups. As users encounter an increasing number of items within a group, the distinctiveness of each individual element diminishes.
92+
Cards should be used in small groups of three to five items, while Pillars can accommodate larger groups of up to six items. The more items in a group, the less distinctive each individual element becomes.
7593

7694
<DoDontContainer>
7795
<Do>
7896
<img src="https://github.com/primer/brand/assets/912236/bc33c846-71c2-4af6-a3ac-f886bad71995" />
79-
<Caption>Pillars are more suitable for groups of 5 or more items.</Caption>
97+
<Caption>Pillars are suitable for groups of up to six items.</Caption>
8098
</Do>
8199
<Dont>
82100
<img src="https://github.com/primer/brand/assets/912236/302dbc4d-6199-4c0c-96d5-76ac2e35fdea" />
83101
<Caption>
84-
Don't use Cards for groups of 5 or more items. Use them sparingly in
85-
groups of 3 or 4.
102+
Don't use Cards for groups of five or more items. Use them sparingly in
103+
groups of three or four.
86104
</Caption>
87105
</Dont>
88106
</DoDontContainer>

0 commit comments

Comments
 (0)