Skip to content

Commit 385456c

Browse files
authored
Merge pull request #220 from puppetlabs/Sigler-icon-art
(PDS-450) Update Iconography.md
2 parents 09e6ab6 + 3f14753 commit 385456c

File tree

7 files changed

+257
-13
lines changed

7 files changed

+257
-13
lines changed

packages/design-system-website/foundations/Iconography.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,22 @@ Icon design sits squarely within a venn diagram between illustration and product
44

55
A list of available icons are available in the [icon component](#/React%20Components/Icon).
66

7-
`Insert venn diagram`
87

98
## Icon construction
109

1110
### Grid
1211

1312
By default our icons align to our 4px grid on a 16x16 artboard. We allow icons to be scaled up to 24x24.
1413

15-
`Insert grid examples`
14+
![Merge icon on 16x16 grid](./icon-grid.svg)
1615

1716
When we reduce to 8x8, we always create a new icon. It is important that we remove non-critical detail as we scale down.
1817

1918
When scaling up to 24x24 consider creating a new icon, taking advantage of the larger space to add interesting and useful detail.
2019

2120
Icons are not scaled up over 24x24 pixels. If you need something larger use an illustration instead. Icons may be used as development placeholders, but should always be made into a more detailed illustration before being made public-facing.
2221

23-
`Insert placeholder and illustration examples`
22+
![Example of reducing complexity when reducing size](./icon-size-complexity.svg)
2423

2524
## Pixel grid
2625

@@ -51,23 +50,20 @@ Icons should clearly communicate their associated content. They also reflect the
5150

5251
### Silhouettes
5352

54-
Because of the technical nature of Puppet's products, most icons will not have a clear meaning by themselves. Instead the icon primarily provides a distinguishing characteristic to help the user navigate between similar topics or actions.
53+
A distinct silhouette helps the user quickly identify and understand iconography as they scan across a page. Because of the technical nature of Puppet's products, most icons will not have a clear meaning by themselves. Instead the icon primarily provides a distinguishing characteristic to help the user navigate between similar topics or actions.
5554

56-
To accomplish this we must always review how icons will be used in-situ. This is exceptionally important in navigation, where a user relies more on a passing familiarity and position on screen to return to a specific screen.
55+
This is exceptionally important in navigation, where a user relies more on a passing familiarity and position on screen to return to a specific screen.
5756

58-
`Insert navigation example`
57+
![Example of icons with distinct silhouettes and confusing silhouettes](./icon-silhouette.svg)
5958

6059
## Using icons in isolation
6160

6261
The vast majority of icons do not provide enough information by themselves for a user to understand their purpose. It is very important that when using icons that we provide enough context for the user. **That does not mean icons always need text next to them**. It means we need to be considerate when providing context in other ways to aid user understanding.
6362

64-
`Insert WSYWIG toolbar image`
63+
![Example showcasing how a bell icon may be easily recognizable without text, while a box may not.](./icon-notext.svg)
6564

66-
**Example**: The toolbar for a text editor needs to conserve space so all actions are visible. Context here is provided by:
65+
![Ellipsis and kebab icons are ok to use without text](./icon-kebabs.svg)
6766

68-
- Clear association with the text editor - presented as buttons, grouped into a toolbar
69-
- Leaning on broad familiarity with text editors in general
70-
- Using common icon metaphors
7167

7268
**Consider**
7369

@@ -131,9 +127,9 @@ Test that the icon:
131127

132128
- Scales correctly
133129
- Accepts style changes
134-
- Name corresponds with Sketch library and exported svg
130+
- Name corresponds with Sketch library and exported SVG
135131
- Is added to documentation
136132

137133
## Related
138134

139-
- [Icon component](#/React%20Components/Icon) : a list of available icons and guidelines for using them
135+
- [Icon component](#/React%20Components/Icon): a list of available icons and guidelines for using them

packages/design-system-website/public/icon-grid.svg

+19
Loading

packages/design-system-website/public/icon-kebabs.svg

+33
Loading

packages/design-system-website/public/icon-notext.svg

+34
Loading

packages/design-system-website/public/icon-silhouette.svg

+42
Loading

packages/design-system-website/public/icon-size-complexity.svg

+119
Loading

packages/react-components/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
- [sass-variables] Add breakpoint variables and media query mixins for use in responsive layouts (by [@caseywilliams](https://github.com/caseywilliams) in [#218](https://github.com/puppetlabs/design-system/pull/218))
44
- [RadioButton] Add new Radiobutton component (by [@jilliankeenan](https://github.com/jilliankeenan) in [#215](https://github.com/puppetlabs/design-system/pull/215))
55
- [Checkbox] Fix color of checked icon for error state (by [@jilliankeenan](https://github.com/jilliankeenan) in [#215](https://github.com/puppetlabs/design-system/pull/215))
6+
- [Docs] Update icon docs with how to add new icons (by [@vine77](https://github.com/vine77) in [#221](https://github.com/puppetlabs/design-system/pull/221)) and art/examples in the Iconography guide (by [@Sigler](https://github.com/Sigler) in [#220](https://github.com/puppetlabs/design-system/pull/220))
67

78
# [5.15.2](https://github.com/puppetlabs/design-system/compare/@puppet/[email protected]...@puppet/[email protected]) (2020-02-12)
89

0 commit comments

Comments
 (0)