Skip to content

Commit

Permalink
docs: polish iconography foundations
Browse files Browse the repository at this point in the history
- split into 2 pages, icons and country symbols,  to aid readability
- added filters to icon preview, so you can show/hide solid/outline icons
- aligned the country symbol preview component with the icon preview (clear button etc, no results view)
  • Loading branch information
amritadesmet authored and mark-tate committed Nov 9, 2024
1 parent 91973ac commit 4bd1536
Show file tree
Hide file tree
Showing 22 changed files with 322 additions and 75 deletions.
2 changes: 2 additions & 0 deletions site/docs/foundations/accent.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Accent
layout: DetailTechnical
sidebar:
priority: 14
data:
status: In progress
---
Expand Down
3 changes: 2 additions & 1 deletion site/docs/foundations/color.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Color
layout: DetailTechnical
data:
sidebar:
priority: 13
---

Colors can be used to communicate meaning, establish visual hierarchy, and differentiate products, all while ensuring a cohesive and accessible experience. Colors are divided into several categories to communicate several concepts across the Salt design system.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/density.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Density
layout: DetailTechnical
sidebar:
priority: 12
---

Density relates to the amount of content that can fit on a screen based on the [size](./size) and [spacing](./spacing) of components.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/division.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Division
layout: DetailTechnical
sidebar:
priority: 11
data:
status: In progress
---
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/duration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Duration
layout: DetailTechnical
sidebar:
priority: 10
---

Duration represents the time between a user performing an action and the system giving feedback. Consistency in timing provides comfort and can increase trust in a system.
Expand Down
12 changes: 0 additions & 12 deletions site/docs/foundations/iconography.mdx

This file was deleted.

39 changes: 39 additions & 0 deletions site/docs/foundations/iconography/country-symbols.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Country Symbols
layout: DetailTechnical
---

Country symbols represent a specific country and are used in contexts where geographical identification is necessary.

- Country symbols can be considered icons that are visually representative of a country or inter-governmental organisation.
- All flags are available in both circle and rectangle shapes.

<Image
src="/img/foundations/iconography-countrysymbols-variant.png"
alt="Example of circular flag next to rectangular flag"
/>

## All country symbols

<CountrySymbolPreview />

## Scaling country symbols

Country symbols have a standard size that changes in multiples across all four density levels.

<ImageSwitcher
images={[
{ src: "/img/foundations/scale-country.svg", alt: "" },
{ src: "/img/foundations/scale-country-annotated.svg", alt: "" },
]}
label="Show multipliers"
/>

| Size token | Multiplier | High density (px) | Medium | Low | Touch |
| ------------------ | ---------- | ----------------- | ------ | --- | ----- |
| `--salt-size-base` | x1 | 20 | 28 | 36 | 44 |
| | x2 | 40 | 56 | 72 | 88 |
| | x3 | 60 | 84 | 108 | 132 |
| | x4 | 80 | 112 | 144 | 176 |

:fragment{src="./../fragments/feedback.mdx"}
46 changes: 46 additions & 0 deletions site/docs/foundations/iconography/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Icons
layout: DetailTechnical
sidebar:
groupLabel: Iconography
label: Icons
priority: 9
---

Icons are simplified visual representations of a specific action, object or concept.

<Image
src="/img/foundations/iconography-icon-variants.png"
alt="Example of solid and outline icons"
/>

Icons come in two variant types: **Outline** and **Solid**. Please note that all icons within the icon set have an outline variant, but not all icons have a solid variant.

**Solid icons** are faster to recognize than outline icons due to less visual noise, especially when the icon is complex. Solid icons better represent how we view objects, whereas outline icons are silhouettes and therefore can take longer to perceive.

**Outline icons** place less emphasis on non-imperative items and are more recognizable when they have wider inner spacing. They’re also better to use when you need to make subtle design cues more noticeable.

## All icons

<IconPreview />

## Scaling icons

Icon size will vary based on use case and system requirements. Standard sizing ensures components maintain a consistent spatial relationship with surrounding elements.

<ImageSwitcher
images={[
{ src: "/img/foundations/scale-icon.svg", alt: "" },
{ src: "/img/foundations/scale-icon-annotated.svg", alt: "" },
]}
label="Show multipliers"
/>

| Size token | Multiplier | High density (px) | Medium | Low | Touch |
| ------------------ | ---------- | ----------------- | ------ | --- | ----- |
| `--salt-size-icon` | x1 | 12 \* | 12 | 14 | 16 |
| | x2 | 20 | 24 | 28 | 32 |
| | x3 | 30 | 36 | 42 | 48 |
| | x4 | 40 | 48 | 56 | 64 |

\* Icons have a minimum size set at 12px and should not be displayed any smaller. For high density this means the default size of an icon is 12px, but the rest of the scale grows based on small base dimension.
2 changes: 2 additions & 0 deletions site/docs/foundations/modes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Modes
layout: DetailTechnical
sidebar:
priority: 8
data:
status: In progress
---
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/opacity.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Opacity
layout: DetailTechnical
sidebar:
priority: 7
data:
status: In progress
---
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/responsiveness.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Responsiveness
layout: DetailTechnical
sidebar:
priority: 6
---

A responsive layout makes dynamic changes to the appearance of a product in response to the size of the screen.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/scale.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Scale
layout: DetailTechnical
sidebar:
priority: 5
---

Scale allows you to give components greater or lesser prominence within an interface through a multiplier of their default size.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/shadow.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Shadow
layout: DetailTechnical
sidebar:
priority: 4
data:
status: In progress
---
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/size.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Size
layout: DetailTechnical
sidebar:
priority: 3
---

Size refers to the restricted dimensions provided within the design system, such as an element's height and/or width.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/spacing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Spacing
layout: DetailTechnical
sidebar:
priority: 2
---

The organization of space is a key aspect of design. Spatial tokens help align layouts and create consistent visual rhythm.
Expand Down
2 changes: 2 additions & 0 deletions site/docs/foundations/typography.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Typography
layout: DetailTechnical
sidebar:
priority: 1
---

Typography involves the style and appearance of written language. It plays a crucial role in enhancing readability, establishing hierarchy, and setting a visual tone, resulting in more effective and expressive communication.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
113 changes: 113 additions & 0 deletions site/src/components/country-symbol-preview/CountrySymbolPreview.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
import {

Check failure on line 1 in site/src/components/country-symbol-preview/CountrySymbolPreview.tsx

View workflow job for this annotation

GitHub Actions / lint

organizeImports

Import statements differs from the output
FlexLayout,
FlexItem,
FlowLayout,
Input,
StackLayout,
Text,
Button,
StatusIndicator,
} from "@salt-ds/core";
import { LazyCountrySymbol, countryMetaMap } from "@salt-ds/countries";
import {
ChangeEvent,
Suspense,
useDeferredValue,
useMemo,
useState,
} from "react";

Check failure on line 18 in site/src/components/country-symbol-preview/CountrySymbolPreview.tsx

View workflow job for this annotation

GitHub Actions / lint

lint/style/useImportType

Some named imports are only used as types.
import styles from "../icon-preview/IconPreview.module.css";
import { CloseIcon, SearchIcon } from "@salt-ds/icons";

export const CountrySymbolPreview = () => {
const [search, setSearch] = useState("");
const deferredSearch = useDeferredValue(search.toLowerCase());

const handleSearch = (event: ChangeEvent<HTMLInputElement>) => {
setSearch(event.target.value);
};

const handleClear = () => {
setSearch("");
};

const filteredSymbols = useMemo(() => {
return Object.values(countryMetaMap).filter(
({ countryCode, countryName }) =>
countryCode.toLowerCase().includes(deferredSearch) ||
countryName.toLowerCase().includes(deferredSearch),
);
}, [deferredSearch]);

const renderSymbols = useMemo(() => {
if (filteredSymbols.length > 0) {
return (
<FlowLayout justify="start" gap={1}>
{filteredSymbols.map(({ countryCode, countryName }) => (
<StackLayout
style={{ width: 140 }}
gap={1}
align="center"
key={countryCode}
>
<LazyCountrySymbol code={countryCode} size={1} />
<Text>{countryCode}</Text>
<Text style={{ textAlign: "center" }}>{countryName}</Text>
</StackLayout>
))}
</FlowLayout>
);
}
return (
<StackLayout className={styles.notFound} gap={3} align="center">
<StatusIndicator status="info" size={2} />
<StackLayout gap={1} align="center">
<Text styleAs="h4">
<strong>No country symbols found</strong>
</Text>
<Text>
No country symbols found for the search term: "
<strong>{deferredSearch}</strong>"
</Text>
</StackLayout>
</StackLayout>
);
}, [filteredSymbols, deferredSearch]);

return (
<Suspense fallback="Loading...">
<StackLayout className={styles.root} gap={1}>
<FlexLayout direction="row">
<FlexItem>
<Input
placeholder="Search country symbols"
aria-label="Search country symbols"
value={search}
onChange={handleSearch}
className={styles.search}
startAdornment={<SearchIcon />}
endAdornment={
search && (
<Button
onClick={handleClear}
appearance="transparent"
sentiment="neutral"
aria-label="Clear search"
>
<CloseIcon aria-hidden />
</Button>
)
}
/>
</FlexItem>
</FlexLayout>
<div
className={styles.symbolsContainer}
style={{ overflow: "auto", maxHeight: 800, marginTop: "12px" }}
>
{renderSymbols}
</div>
</StackLayout>
</Suspense>
);
};
1 change: 1 addition & 0 deletions site/src/components/country-symbol-preview/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "./CountrySymbolPreview";
Loading

0 comments on commit 4bd1536

Please sign in to comment.