Skip to content

Commit c75e3f2

Browse files
authored
Merge pull request #565 from dxc-technology/component-alert
Component alert documentation fixes
2 parents 38389f0 + eec81dc commit c75e3f2

File tree

6 files changed

+34
-20
lines changed

6 files changed

+34
-20
lines changed
17.8 KB
Binary file not shown.

guidelines/components/alert/README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,26 @@ _Context-based alert types_
3535
| **Inline** | The notification appears in the up right corner of the screen staying visible for 10 seconds |
3636
| **Modal** | The notification appears centered in the screen using an overlay that obscures the content below |
3737

38+
39+
## States
40+
41+
States for the close action of the alert component: **Enabled**, **hover**, **focus**, and **active**.
42+
43+
![Alert action specs](images/alert_states.png)
44+
45+
_Alert action specs_
46+
47+
3848
## Anatomy
3949

4050
![Alert component anatomy](images/alert_anatomy.png)
4151

42-
1. Icon
43-
2. Label
44-
3. Alert message
45-
4. Close action (Optional)
46-
5. Description (Optional)
52+
1. Container
53+
2. Icon
54+
3. Title
55+
4. Inline text
56+
5. Close action
57+
6. Content _(Optional)_
4758

4859
## Content
4960

@@ -68,24 +79,26 @@ Depending on the content that need to be displayed, more detailed descriptions c
6879
| `errorBackgroundColor` | Container background | `color-red-100` | #ffe6e9 |
6980
| `infoBorderColor` | Container border | `color-blue-800` | #0067b3 |
7081
| `successBorderColor` | Container border | `color-green-700` | #24a148 |
71-
| `warningBorderColor` | Container border | `color-yellow-500` | #f7cf2b |
82+
| `warningBorderColor` | Container border | `color-yellow-700` | #c59f07 |
7283
| `errorBorderColor` | Container border | `color-red-700` | #d0011b |
73-
| `titleFontColor` | Label | `color-black` | #000000 |
74-
| `contentFontColor` | Content | `color-black` | #000000 |
75-
| `focusColor` | Action:focus | `color-blue-800` | #0067b3 |
84+
| `titleFontColor` | Title | `color-black` | #000000 |
85+
| `inlineTextFontColor` | Inline text | `color-black` | #000000 |
86+
| `hoverActionBackgroundColor` | Action:hover | - | #0000000d |
87+
| `activeActionBackgroundColor` | Action:active | - | #0000001a |
88+
| `focusActionBorderColor` | Action:focus | `color-blue-600` | #0095ff |
7689
| `overlayColor` | Overlay | - | #000000B3 |
7790

7891

7992
### Typography
8093

8194
| Component token | Element | Core token | Value |
8295
| :------------------------------------------ | :--------------------------- | :--------------------- | :------------------------ |
83-
| `titleFontFamily` | Label | `font-family-sans` | 'Open Sans', sans-serif; |
84-
| `titleFontSize` | Label | `font-scale-01` | 0.75rem / 12px |
85-
| `titleFontWeight` | Label | `font-bold` | 600 |
86-
| `contentFontFamily` | Content | `font-family-sans` | 'Open Sans', sans-serif; |
87-
| `contentFontSize` | Content | `font-scale-01` | 0.75rem / 12px |
88-
| `contentFontWeight` | Content | `font-regular` | 400 |
96+
| `titleFontFamily` | Title | `font-family-sans` | 'Open Sans', sans-serif; |
97+
| `titleFontSize` | Title | `font-scale-01` | 0.75rem / 12px |
98+
| `titleFontWeight` | Title | `font-bold` | 600 |
99+
| `inlineTextFontFamily` | Inline text | `font-family-sans` | 'Open Sans', sans-serif; |
100+
| `inlineTextFontSize` | Inline text | `font-scale-01` | 0.75rem / 12px |
101+
| `inlineTextFontWeight` | Inline text | `font-regular` | 400 |
89102

90103

91104
### Border
@@ -98,13 +111,14 @@ Depending on the content that need to be displayed, more detailed descriptions c
98111

99112
### Spacing
100113

101-
| Component token | Element | Core token | Value |
102-
| :------------------------------------------ | :--------------------------- | :--------------------- | :------ |
114+
| Component token | Element | Core token | Value |
115+
| :------------------------------------------ | :--------------------------- | :--------------------- | :---------------- |
103116
| `containerPaddingLeft` | Container | `spacing-04` | 0.75rem / 12px |
104117
| `containerPaddingRight` | Container | `spacing-04` | 0.75rem / 12px |
105-
| `titlePaddingRight` | Label | `spacing-03` | 0.5rem / 8px |
106-
| `inlineTextPaddingRight` | Message | `spacing-03` | 0.5rem / 8px |
107-
| `contentPaddingLeft` | Description | `spacing-09` | 3rem / 48px |
118+
| `iconMarginRight` | Icon | `spacing-03` | 0.75rem / 12px |
119+
| `inlineTextPaddingLeft` | Inline text | `spacing-03` | 0.5rem / 8px |
120+
| `titlePaddingLeft` | Title | `spacing-03` | 0.5rem / 8px |
121+
108122

109123
### Iconography
110124

185 Bytes
Loading
-345 Bytes
Loading
13.9 KB
Loading
-1.19 KB
Loading

0 commit comments

Comments
 (0)