Skip to content

Commit c0441df

Browse files
emirgensCopilot
andauthored
docs: update pages in design tokens (#4216)
* docs: update design tokens documentation for elevation, grid, shape, spacing, and typography * Update apps/design-system-docs/docs/foundation/design-tokens/spacing.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update apps/design-system-docs/docs/foundation/design-tokens/grid.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update apps/design-system-docs/docs/foundation/design-tokens/spacing.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix formatting of keyboard shortcut in grid.md * Update grid.md --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent d6a505c commit c0441df

5 files changed

Lines changed: 24 additions & 247 deletions

File tree

apps/design-system-docs/docs/foundation/design-tokens/elevation.md

Lines changed: 2 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -4,97 +4,13 @@ Elevation is a visual effect that makes an element look like it's floating above
44

55
## Guidelines
66

7-
The elevation effect is made using shadows to help lift an element into focus --- it is a reference to the physical world. Elements may be stacked on top of each other but can’t pass through each other.
7+
The elevation effect is made using shadows to help lift an element into focus, it is a reference to the physical world. Elements may be stacked on top of each other but can’t pass through each other.
88

99
## Styles
1010

1111
There are six elevation effects to choose between:  `None``Raised``Overlay``Sticky``Temporary nav` and `Above scrim`.
1212

13-
None
14-
15-
Fill
16-
17-
rgba(255, 255, 255, 1.0)
18-
19-
Shadow
20-
21-
0.0px 0.0px 1.0px 0px rgba(0, 0, 0, 0.14)
22-
23-
Add notes
24-
25-
Raised
26-
27-
Fill
28-
29-
rgba(255, 255, 255, 1.0)
30-
31-
Shadow
32-
33-
0.0px 1.0px 5.0px 0px rgba(0, 0, 0, 0.2),0.0px 3.0px 4.0px 0px rgba(0, 0, 0, 0.12),0.0px 2.0px 4.0px 0px rgba(0, 0, 0, 0.14)
34-
35-
Add notes
36-
37-
Overlay
38-
39-
Fill
40-
41-
rgba(255, 255, 255, 1.0)
42-
43-
Shadow
44-
45-
0.0px 1.0px 10.0px 0px rgba(0, 0, 0, 0.2),0.0px 4.0px 5.0px 0px rgba(0, 0, 0, 0.12),0.0px 2.0px 4.0px 0px rgba(0, 0, 0, 0.14)
46-
47-
Add notes
48-
49-
Sticky
50-
51-
Fill
52-
53-
rgba(255, 255, 255, 1.0)
54-
55-
Shadow
56-
57-
0.0px 4.0px 5.0px 0px rgba(0, 0, 0, 0.2),0.0px 3.0px 14.0px 0px rgba(0, 0, 0, 0.12),0.0px 8.0px 10.0px 0px rgba(0, 0, 0, 0.14)
58-
59-
Add notes
60-
61-
Temporary Nav
62-
63-
Fill
64-
65-
rgba(255, 255, 255, 1.0)
66-
67-
Shadow
68-
69-
0.0px 7.0px 8.0px 0px rgba(0, 0, 0, 0.2),0.0px 5.0px 22.0px 0px rgba(0, 0, 0, 0.12),0.0px 12.0px 17.0px 0px rgba(0, 0, 0, 0.14)
70-
71-
Add notes
72-
73-
Above Scrim
74-
75-
Fill
76-
77-
rgba(255, 255, 255, 1.0)
78-
79-
Shadow
80-
81-
0.0px 11.0px 15.0px 0px rgba(0, 0, 0, 0.2),0.0px 9.0px 46.0px 0px rgba(0, 0, 0, 0.12),0.0px 24.0px 38.0px 0px rgba(0, 0, 0, 0.14)
82-
83-
Add notes
84-
85-
86-
87-
# Design
88-
89-
When expanded use tab to review current page headings and press enter or space to navigate to the selected section
90-
91-
DESIGN TOKENS
92-
93-
# Elevation
94-
95-
Elevation is a visual effect that makes an element look like it's floating above the surface (using the z-axis).
96-
97-
## Figma
13+
## Implementation in Figma
9814

9915
### How to add
10016

apps/design-system-docs/docs/foundation/design-tokens/grid.md

Lines changed: 13 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Screen size is determined by the device and the user's window size. The EDS grid
88

99
### Grid layouts
1010

11-
- It is the responsibility of the designer to define a maximum width and choose the correct grid.
11+
- It is the responsibility of the designer to define a maximum width and choose the correct grid
12+
- It is up to the designer to make sure the design will scale correctly on all sizes.
13+
- Start with a viewport that is the most common for the users, make sure to test that the content will fit at smaller and larger viewports
14+
- It is the responsibility of the developers to implement the maximum width and use the grid as designed
1215

13-
- It is up to the designer to make sure the design will scale correctly on all sizes. Start with a viewport that is the most common for the users. Make sure to test that the content will fit at smaller and larger viewports.
14-
15-
- It is the responsibility of the developers to implement the maximum width and use the grid as designed.
16-
17-
18-
Tip: _Always remember to test designs and code by scaling the screen size or changing the orientation of the device._
16+
:::tip Tip
17+
Always remember to test designs and code by scaling the screen size or changing the orientation of the device.
18+
:::
1919

2020
### Grid influencers
2121

@@ -28,71 +28,41 @@ When using a canvas navigation drawer or sidesheet, the content container could
2828
The columns used in the grid are **fluid** in width. There is not a defined width.
2929

3030
- `Grid/Large`
31-
3231
- Use in content areas that are between 840px and larger.
33-
3432
- `Grid/Medium`
35-
3633
- Use in content areas that are 600--839px.
37-
3834
- `Grid/Small`
39-
4035
- Use in content areas that are 0--599px.
41-
4236

4337
### Grid margins
4438

4539
Grid margins are the space at the outer edge of the grid against the frame's edge. Grid styles are available with and without margins. It is up to the designer to decide which works best for your interface.
4640

4741
- `Grid/Large`
48-
4942
- Margins are set to 32px.
50-
5143
- `Grid/Medium`
52-
5344
- Margins are set to 24px.
54-
5545
- `Grid/Small`
56-
5746
- Margins are set to 16px.
58-
5947

6048
### Grid gutters
6149

6250
Grid gutters are the space in between the columns of the grid.
6351

6452
- `Grid/Large`
65-
6653
- Gutters are set to 16px.
67-
6854
- `Grid/Medium`
69-
7055
- Gutters are set to 16px.
71-
7256
- `Grid/Small`
73-
7457
- Gutters are set to 8px.
75-
76-
77-
- Visit  for more details on on how to use the grid together with components.
78-
79-
80-
81-
# Design
82-
83-
When expanded use tab to review current page headings and press enter or space to navigate to the selected section
84-
85-
DESIGN TOKENS
86-
87-
# Grid
88-
89-
A grid adapts to screen size and orientation to help keep layouts consistent.
9058

91-
## Figma
59+
:::info More information
60+
Visit [grid patterns](../patterns.md#grid-system-and-spacing) for more details on how to use the grid together with components
61+
:::
9262

93-
### How to add
63+
## Implementation in Figma
9464

95-
1. Click `A` or `F`on the keyboard to open the predefined list of frame sizes.
65+
1. Click `A` or `F` on the keyboard to open the predefined list of frame sizes.
9666

9767
2. Locate the **Design** tab in the **Inspector Panel**.
9868

@@ -102,4 +72,4 @@ A grid adapts to screen size and orientation to help keep layouts consistent.
10272

10373
5. Under the **Layout grid** section, open the **Style library** menu to view the grid styles.
10474

105-
6. Choose a style by clicking on the style needed. Only one grid can be applied at a time.
75+
6. Choose a style by clicking on the style needed. Only one grid can be applied at a time.

apps/design-system-docs/docs/foundation/design-tokens/shape.md

Lines changed: 0 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -10,82 +10,3 @@ To reflect the round corners of the Equinor logo, our shapes have a default roun
1010

1111
There are many different shapes to choose between when you are building a component such as: `Button``Icon button``Corners`,  `Straight``Field`  and `Circle`.
1212

13-
Button
14-
15-
Add notes
16-
17-
Button
18-
19-
Add notes
20-
21-
Circle
22-
23-
Add notes
24-
25-
Circle
26-
27-
Add notes
28-
29-
Corners
30-
31-
Add notes
32-
33-
Corners
34-
35-
Add notes
36-
37-
Icon Button
38-
39-
Add notes
40-
41-
Icon Button
42-
43-
Add notes
44-
45-
Rounded
46-
47-
Add notes
48-
49-
Rounded
50-
51-
Add notes
52-
53-
Straight
54-
55-
Add notes
56-
57-
Straight
58-
59-
Add notes
60-
61-
Toggle
62-
63-
Add notes
64-
65-
Toggle
66-
67-
Add notes
68-
69-
Toggle rounded border
70-
71-
Add notes
72-
73-
Toggle rounded border
74-
75-
Add notes
76-
77-
Toggle straight border
78-
79-
Add notes
80-
81-
Toggle straight border
82-
83-
Add notes
84-
85-
Caret
86-
87-
Add notes
88-
89-
Field
90-
91-
Add notes

apps/design-system-docs/docs/foundation/design-tokens/spacing.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,15 @@ Spacing is used to apply margin and padding across all platforms. The EDS has a
88

99
The spacers `XX Small` and `X Small` are only to be used inside of components, while the spacers `Small` up to `XXX Large` can be used both within and between components.
1010

11-
- Always make sure to follow the  by having 8px of spacing between each clickbound.
11+
:::info Guideline
12+
Always make sure to follow the guideline by having 8px of spacing between each clickbound.
13+
:::
1214

15+
### Variants
1316

1417
There are eight spacers to choose between: `XX Small``X Small``Small``Medium``Large``X Large``XX Large` and `XXX Large`. The spacers `XX Small` and `X Small` are only to be used inside components, while the other spacers are to be used in layouts.
1518

16-
17-
18-
# Usage
19-
20-
When expanded use tab to review current page headings and press enter or space to navigate to the selected section
21-
22-
DESIGN TOKENS
23-
24-
# Spacing
25-
26-
Every part of your interface should be intentional, this also includes spacing. While spacing is invisible, it gives air and readability to your interface.
27-
28-
## Figma
19+
## Implementation in Figma
2920

3021
### How to add
3122

apps/design-system-docs/docs/foundation/design-tokens/typography.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Typography presents hierarchy and organises information as clearly and efficient
66

77
The Equinor typeface is the primary typeface and is available in four weights: `light``regular``medium` and `bold` with accompanying italics. Please do not use `light` in digital interfaces except in special cases where the font size is over 48px.
88

9-
_Note: Typography is called text styles in Figma._
9+
:::info Note
10+
Typography is called text styles in Figma.
11+
:::
1012

1113
### Paragraph length
1214

@@ -30,19 +32,7 @@ The style `Body short` is used for short sentences containing around four word
3032

3133
There are other typography styles that are used internally within components.
3234

33-
34-
35-
# Design
36-
37-
When expanded use tab to review current page headings and press enter or space to navigate to the selected section
38-
39-
DESIGN TOKENS
40-
41-
# Typography
42-
43-
Typography presents hierarchy and organises information as clearly and efficiently as possible.
44-
45-
## Figma
35+
## Implementation in Figma
4636

4737
### How to add
4838

@@ -54,14 +44,3 @@ Typography presents hierarchy and organises information as clearly and efficient
5444

5545
4. Choose a style by clicking on the style needed.
5646

57-
58-
59-
# Code
60-
61-
When expanded use tab to review current page headings and press enter or space to navigate to the selected section
62-
63-
DESIGN TOKENS
64-
65-
# Typography
66-
67-
Typography presents hierarchy and organises information as clearly and efficiently as possible.

0 commit comments

Comments
 (0)