Skip to content

Commit 47991b9

Browse files
authored
Merge pull request #514 from dxc-technology/component-chip
Component chip documentation update
2 parents c870a83 + 7aae8d0 commit 47991b9

File tree

8 files changed

+52
-21
lines changed

8 files changed

+52
-21
lines changed
55.7 KB
Binary file not shown.

guidelines/components/chip/README.md

Lines changed: 52 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,27 @@ Chips are elements that represent status, complementary information, or associat
1010

1111
## States
1212

13-
The only interactive element on the chip component is the prefix/suffix and its states are: **enabled** and **focus**:
13+
The chip component container states are: **enabled** and **disabled**:
1414

15-
![Chip prefix and suffix states](images/chip_states.png)
15+
![Chip container states](images/chip_states_container.png)
16+
17+
_Chip container states_
18+
19+
The chip action item has the following states: **enabled**, **hover**, **focus**, **active**, and **disabled**:
20+
21+
![Chip prefix and suffix states](images/chip_states_action.png)
1622

1723
_Chip prefix and suffix states_
1824

25+
## Anatomy
26+
27+
![Ccomponent anatomy](images/chip_anatomy.png)
28+
29+
1. Container
30+
2. Prefix _(Optional)_
31+
3. Label
32+
4. Suffix _(Optional)_
33+
1934
## Design Specifications
2035

2136
![Component chip design specifications](images/chip_specs.png)
@@ -24,31 +39,49 @@ _Component chip design specifications_
2439

2540
### Color
2641

42+
#### On-light
43+
2744
| Component token | Element | Token | Value |
2845
| :------------------------ | :------------------------ | :---------------------- | :-------- |
2946
| `backgroundColor` | Chip container | `color-grey-200` | #e6e6e6 |
3047
| `disabledBackgroundColor` | Chip container:disabled | `color-grey-100` | #f2f2f2 |
3148
| `fontcolor` | Label | `color-black` | #000000 |
32-
| `fontcolor` | Label:disabled | `color-grey-500` | #999999 |
33-
| `focusColor` | Focus outline | `color-blue-800` | #0067b3 |
49+
| `disabledFontcolor` | Label:disabled | `color-grey-500` | #999999 |
50+
| `focusColor` | Focus outline | `color-blue-600` | #0095ff |
3451
| `iconColor` | Icon | `color-black` | #000000 |
35-
| `iconColor` | Icon:disabled | `color-grey-500` | #999999 |
52+
| `disabledIconColor` | Icon:disabled | `color-grey-500` | #999999 |
3653

54+
#### On-dark
3755

38-
### Size
56+
| Component token | Element | Token | Value |
57+
| :------------------------------ | :------------------------ | :---------------------- | :-------- |
58+
| `backgroundColorOnDark` | Chip container | `color-grey-700` | #666666 |
59+
| `disabledBackgroundColorOnDark` | Chip container:disabled | `color-grey-800` | #4d4d4d |
60+
| `fontcolorOnDark` | Label | `color-white` | #ffffff |
61+
| `disabledfontcolorOnDark` | Label:disabled | `color-grey-500` | #999999 |
62+
| `focusColorOnDark` | Focus outline | `color-blue-600` | #0095ff |
63+
| `iconColorOnDark` | Icon | `color-white` | #ffffff |
64+
| `iconColorOnDark` | Icon:disabled | `color-grey-500` | #999999 |
3965

40-
| Property | Element | Value |
41-
| --------------- | ----------------------------- | ------------- |
42-
| `min-height` | Chip container | 40px |
43-
| `height` | Prefix/Suffix | 24px |
44-
| `width` | Prefix/Suffix | 24px |
66+
67+
### Typography
68+
69+
| Component token | Element | Core token | Value |
70+
| :----------------------- | :--------------- | :------------------------- | :------------------------- |
71+
| `fontFamily` | Label | `font-family-sans` | 'Open Sans', sans-serif |
72+
| `fontSize` | Label | `font-scale-03` | 1rem / 16px |
73+
| `fontStyle` | Label | `font-style-normal` | normal |
74+
| `fontWeight` | Label | `font-weight-regular` | 400 |
4575

4676
### Spacing
4777

48-
| Property | Element | Value |
49-
| --------------------- | --------------------- | ----- |
50-
| `padding-left/right` | Chip container | 16px |
51-
| `margin` | Prefix/Suffix | 8px |
78+
| Component token | Element | Core token | Value |
79+
| :----------------------- | :-------------------- | :-------------- | :---------------- |
80+
| `labelMarginLeft` | Label | `spacing-03` | 0.5rem / 8px |
81+
| `labelMarginRight` | Label | `spacing-03` | 0.5rem / 8px |
82+
| `containerPaddingLeft` | Container | `spacing-03` | 0.5rem / 8px |
83+
| `containerPaddingRight` | Container | `spacing-03` | 0.5rem / 8px |
84+
5285

5386

5487
### Border
@@ -63,13 +96,11 @@ _Component chip design specifications_
6396
| `border-radius` | Focus border | `border-radius-medium` | 0.25rem / 4px |
6497

6598

66-
### Typography
67-
68-
| Property | Element | Value |
69-
| ------------- | --------- | ----- |
70-
| `font-size` | Label | 16px |
71-
| `font-weight` | Label | 400 |
99+
### Size
72100

101+
| Component token | Element | Core token | Value |
102+
| :----------------------- | :-------------------- | :------------------ | :-------------- |
103+
| `iconSize` | Prefix/Suffix | `size-icon-large` | 24x24px |
73104

74105

75106
## Links and references
10.7 KB
Loading
-1.75 KB
Loading
-9.54 KB
Binary file not shown.
12.5 KB
Loading
8.13 KB
Loading
-1.17 KB
Loading

0 commit comments

Comments
 (0)