@primer/primitives 11.4.0-rc.daff2d10 → 11.4.0-rc.e472be0d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/build/formats/markdownLlmGuidelines.d.ts +3 -1
- package/dist/build/formats/markdownLlmGuidelines.js +53 -10
- package/dist/build/platforms/llmGuidelines.js +1 -0
- package/dist/build/preprocessors/inheritGroupProperties.d.ts +7 -0
- package/dist/build/preprocessors/inheritGroupProperties.js +70 -0
- package/dist/build/primerStyleDictionary.js +2 -0
- package/dist/build/schemas/designToken.d.ts +1 -1
- package/dist/build/schemas/designToken.js +113 -21
- package/dist/build/schemas/dimensionToken.d.ts +2 -2
- package/dist/build/schemas/dimensionToken.js +4 -2
- package/dist/build/schemas/validTokenType.d.ts +5 -1
- package/dist/build/schemas/validTokenType.js +71 -17
- package/dist/css/functional/size/size-coarse.css +3 -3
- package/dist/css/functional/size/size-fine.css +3 -3
- package/dist/css/functional/themes/dark-colorblind-high-contrast.css +4 -4
- package/dist/css/functional/themes/dark-colorblind.css +4 -4
- package/dist/css/functional/themes/dark-dimmed-high-contrast.css +4 -4
- package/dist/css/functional/themes/dark-dimmed.css +4 -4
- package/dist/css/functional/themes/dark-high-contrast.css +4 -4
- package/dist/css/functional/themes/dark-tritanopia-high-contrast.css +4 -4
- package/dist/css/functional/themes/dark-tritanopia.css +4 -4
- package/dist/css/functional/themes/dark.css +4 -4
- package/dist/css/functional/themes/light-colorblind-high-contrast.css +4 -4
- package/dist/css/functional/themes/light-colorblind.css +4 -4
- package/dist/css/functional/themes/light-high-contrast.css +4 -4
- package/dist/css/functional/themes/light-tritanopia-high-contrast.css +4 -4
- package/dist/css/functional/themes/light-tritanopia.css +4 -4
- package/dist/css/functional/themes/light.css +4 -4
- package/dist/docs/functional/size/size-coarse.json +45 -3
- package/dist/docs/functional/size/size-fine.json +45 -3
- package/dist/docs/functional/themes/dark-colorblind-high-contrast.json +22 -2
- package/dist/docs/functional/themes/dark-colorblind.json +22 -2
- package/dist/docs/functional/themes/dark-dimmed-high-contrast.json +22 -2
- package/dist/docs/functional/themes/dark-dimmed.json +22 -2
- package/dist/docs/functional/themes/dark-high-contrast.json +22 -2
- package/dist/docs/functional/themes/dark-tritanopia-high-contrast.json +22 -2
- package/dist/docs/functional/themes/dark-tritanopia.json +22 -2
- package/dist/docs/functional/themes/dark.json +22 -2
- package/dist/docs/functional/themes/light-colorblind-high-contrast.json +22 -2
- package/dist/docs/functional/themes/light-colorblind.json +22 -2
- package/dist/docs/functional/themes/light-high-contrast.json +22 -2
- package/dist/docs/functional/themes/light-tritanopia-high-contrast.json +22 -2
- package/dist/docs/functional/themes/light-tritanopia.json +22 -2
- package/dist/docs/functional/themes/light.json +22 -2
- package/dist/figma/themes/dark-colorblind.json +2 -0
- package/dist/figma/themes/dark-dimmed.json +2 -0
- package/dist/figma/themes/dark-high-contrast.json +2 -0
- package/dist/figma/themes/dark-tritanopia.json +2 -0
- package/dist/figma/themes/dark.json +2 -0
- package/dist/figma/themes/light-colorblind.json +2 -0
- package/dist/figma/themes/light-high-contrast.json +2 -0
- package/dist/figma/themes/light-tritanopia.json +2 -0
- package/dist/figma/themes/light.json +2 -0
- package/dist/internalCss/dark-colorblind-high-contrast.css +4 -4
- package/dist/internalCss/dark-colorblind.css +4 -4
- package/dist/internalCss/dark-dimmed-high-contrast.css +4 -4
- package/dist/internalCss/dark-dimmed.css +4 -4
- package/dist/internalCss/dark-high-contrast.css +4 -4
- package/dist/internalCss/dark-tritanopia-high-contrast.css +4 -4
- package/dist/internalCss/dark-tritanopia.css +4 -4
- package/dist/internalCss/dark.css +4 -4
- package/dist/internalCss/light-colorblind-high-contrast.css +4 -4
- package/dist/internalCss/light-colorblind.css +4 -4
- package/dist/internalCss/light-high-contrast.css +4 -4
- package/dist/internalCss/light-tritanopia-high-contrast.css +4 -4
- package/dist/internalCss/light-tritanopia.css +4 -4
- package/dist/internalCss/light.css +4 -4
- package/dist/styleLint/functional/size/size-coarse.json +42 -0
- package/dist/styleLint/functional/size/size-fine.json +42 -0
- package/dist/styleLint/functional/themes/dark-colorblind-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/dark-colorblind.json +20 -0
- package/dist/styleLint/functional/themes/dark-dimmed-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/dark-dimmed.json +20 -0
- package/dist/styleLint/functional/themes/dark-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/dark-tritanopia-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/dark-tritanopia.json +20 -0
- package/dist/styleLint/functional/themes/dark.json +20 -0
- package/dist/styleLint/functional/themes/light-colorblind-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/light-colorblind.json +20 -0
- package/dist/styleLint/functional/themes/light-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/light-tritanopia-high-contrast.json +20 -0
- package/dist/styleLint/functional/themes/light-tritanopia.json +20 -0
- package/dist/styleLint/functional/themes/light.json +20 -0
- package/package.json +1 -1
- package/src/tokens/functional/color/data-vis.json5 +7 -0
- package/src/tokens/functional/color/focus.json5 +5 -0
- package/src/tokens/functional/color/selection.json5 +5 -0
- package/src/tokens/functional/size/size-coarse.json5 +24 -3
- package/src/tokens/functional/size/size-fine.json5 +45 -24
- package/token-guidelines.llm.md +109 -86
package/token-guidelines.llm.md
CHANGED
|
@@ -4,22 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
### bgColor-accent-emphasis
|
|
6
6
|
Strong accent background for active states and focused states
|
|
7
|
-
**Usage:** active-states, current, selected
|
|
7
|
+
**Usage:** active-states, active-toggle, current, selected
|
|
8
8
|
**Rules:** MUST use for selected or active states. Pair with fgColor.onEmphasis for text.
|
|
9
9
|
|
|
10
10
|
### bgColor-accent-muted
|
|
11
11
|
Subtle accent background for informational or selected elements
|
|
12
|
-
**Usage:**
|
|
12
|
+
**Usage:** active-nav-item, highlight, info-banner, selected-row
|
|
13
13
|
**Rules:** Use for selected states or informational highlights. Pair with fgColor.accent for text.
|
|
14
14
|
|
|
15
15
|
### bgColor-attention-emphasis
|
|
16
16
|
Strong attention background for prominent warnings
|
|
17
|
-
**Usage:**
|
|
17
|
+
**Usage:** attention-indicator, caution-label, warning-badge
|
|
18
18
|
**Rules:** Use for prominent warnings. Consider fgColor.default for text due to yellow contrast.
|
|
19
19
|
|
|
20
20
|
### bgColor-attention-muted
|
|
21
21
|
Subtle attention background for warnings and caution states
|
|
22
|
-
**Usage:**
|
|
22
|
+
**Usage:** caution-message, pending-state, warning-banner
|
|
23
23
|
**Rules:** Use for warnings that need user attention. Pair with fgColor.attention for text.
|
|
24
24
|
|
|
25
25
|
### bgColor-closed-emphasis
|
|
@@ -34,17 +34,17 @@ Subtle background for closed state indicators (issues, PRs)
|
|
|
34
34
|
|
|
35
35
|
### bgColor-danger-emphasis
|
|
36
36
|
Emphasized danger background for critical errors and delete confirmations
|
|
37
|
-
**Usage:**
|
|
37
|
+
**Usage:** critical-alert, delete-button, destructive-confirmation
|
|
38
38
|
**Rules:** MUST use for destructive action buttons like delete. Use fgColor.onEmphasis for text on this background.
|
|
39
39
|
|
|
40
40
|
### bgColor-danger-muted
|
|
41
41
|
Muted danger background for error states and destructive action contexts
|
|
42
|
-
**Usage:**
|
|
42
|
+
**Usage:** destructive-action, error-message, validation-error
|
|
43
43
|
**Rules:** Use for error states and destructive action backgrounds. Pair with fgColor.danger for text.
|
|
44
44
|
|
|
45
45
|
### bgColor-default
|
|
46
46
|
Default background color for pages and main content areas
|
|
47
|
-
**Usage:**
|
|
47
|
+
**Usage:** card-background, main-content, page-background
|
|
48
48
|
**Rules:** Use as the primary background for pages and content areas. Do NOT use for emphasis or highlighting.
|
|
49
49
|
|
|
50
50
|
### bgColor-disabled
|
|
@@ -54,12 +54,12 @@ Background for disabled interactive elements
|
|
|
54
54
|
|
|
55
55
|
### bgColor-done-emphasis
|
|
56
56
|
Strong background for completed/done state badges and labels
|
|
57
|
-
**Usage:** done-badge, merged-label
|
|
57
|
+
**Usage:** completed-indicator, done-badge, merged-label
|
|
58
58
|
**Rules:** Use for prominent done/completed state indicators. Pair with fgColor.onEmphasis for text.
|
|
59
59
|
|
|
60
60
|
### bgColor-done-muted
|
|
61
61
|
Subtle background for completed/done state indicators
|
|
62
|
-
**Usage:** completed-task,
|
|
62
|
+
**Usage:** completed-task, done-state, merged-pr
|
|
63
63
|
**Rules:** Use for completed/done status indicators. Conveys finished or merged state.
|
|
64
64
|
|
|
65
65
|
### bgColor-draft-emphasis
|
|
@@ -69,77 +69,77 @@ Strong background for draft state badges and labels
|
|
|
69
69
|
|
|
70
70
|
### bgColor-draft-muted
|
|
71
71
|
Subtle background for draft state indicators
|
|
72
|
-
**Usage:** draft-
|
|
72
|
+
**Usage:** draft-issue, draft-pr, work-in-progress
|
|
73
73
|
**Rules:** Use for draft/WIP status indicators. Conveys incomplete or pending state.
|
|
74
74
|
|
|
75
75
|
### bgColor-emphasis
|
|
76
76
|
High-emphasis dark background for strong visual contrast
|
|
77
|
-
**Usage:**
|
|
77
|
+
**Usage:** badge-background, high-contrast-element, tooltip
|
|
78
78
|
**Rules:** Use for elements needing strong visual emphasis. Pair with fgColor.onEmphasis for text. Do NOT use for large areas.
|
|
79
79
|
|
|
80
80
|
### bgColor-inset
|
|
81
81
|
Inset background for recessed content areas like wells or sunken panels
|
|
82
|
-
**Usage:**
|
|
82
|
+
**Usage:** input-background, recessed-area, sunken-panel, well
|
|
83
83
|
**Rules:** Use for visually recessed areas. Creates depth hierarchy. Suitable for input fields and wells.
|
|
84
84
|
|
|
85
85
|
### bgColor-inverse
|
|
86
86
|
Inverse background that flips between light and dark modes
|
|
87
|
-
**Usage:**
|
|
87
|
+
**Usage:** inverse-theme-element, overlay-content
|
|
88
88
|
**Rules:** Use when you need opposite theme background. Pair with fgColor.onInverse for text.
|
|
89
89
|
|
|
90
90
|
### bgColor-muted
|
|
91
91
|
Muted background for secondary content areas and subtle grouping
|
|
92
|
-
**Usage:**
|
|
92
|
+
**Usage:** code-block-background, secondary-content, sidebar, table-header
|
|
93
93
|
**Rules:** Use for secondary content areas or to create visual grouping. Do NOT use for primary page backgrounds.
|
|
94
94
|
|
|
95
95
|
### bgColor-neutral-emphasis
|
|
96
96
|
Strong neutral background for prominent neutral elements
|
|
97
|
-
**Usage:** neutral-button,
|
|
97
|
+
**Usage:** neutral-button, neutral-indicator, secondary-action
|
|
98
98
|
**Rules:** Use for emphasized neutral elements. Pair with fgColor.onEmphasis for text.
|
|
99
99
|
|
|
100
100
|
### bgColor-neutral-muted
|
|
101
101
|
Subtle neutral background for tags, labels, and secondary UI elements
|
|
102
|
-
**Usage:** neutral-
|
|
102
|
+
**Usage:** counter, neutral-badge, neutral-label, secondary-tag
|
|
103
103
|
**Rules:** Use for neutral semantic meaning. Pair with fgColor.default for text. Do NOT use for status indicators.
|
|
104
104
|
|
|
105
105
|
### bgColor-open-emphasis
|
|
106
106
|
Strong background for open state badges and labels
|
|
107
|
-
**Usage:**
|
|
107
|
+
**Usage:** active-status-badge, open-badge, open-label
|
|
108
108
|
**Rules:** Use for prominent open/active state indicators. Pair with fgColor.onEmphasis for text.
|
|
109
109
|
|
|
110
110
|
### bgColor-open-muted
|
|
111
111
|
Subtle background for open state indicators (issues, PRs)
|
|
112
|
-
**Usage:** open-issue, open-pr
|
|
112
|
+
**Usage:** active-status, open-issue, open-pr
|
|
113
113
|
**Rules:** Use for open/active status indicators. Specifically for GitHub issues and PRs.
|
|
114
114
|
|
|
115
115
|
### bgColor-severe-emphasis
|
|
116
116
|
Strong severe background for prominent high-priority warnings
|
|
117
|
-
**Usage:** severe-badge, urgent-label
|
|
117
|
+
**Usage:** high-priority-indicator, severe-badge, urgent-label
|
|
118
118
|
**Rules:** Use for prominent severe warnings. Pair with fgColor.onEmphasis for text.
|
|
119
119
|
|
|
120
120
|
### bgColor-severe-muted
|
|
121
121
|
Subtle severe background for high-priority warnings
|
|
122
|
-
**Usage:** high-priority-warning, urgent-message
|
|
122
|
+
**Usage:** escalation, high-priority-warning, urgent-message
|
|
123
123
|
**Rules:** Use for severe warnings, less critical than danger. Pair with fgColor.severe for text.
|
|
124
124
|
|
|
125
125
|
### bgColor-sponsors-emphasis
|
|
126
126
|
Strong background for prominent GitHub Sponsors elements
|
|
127
|
-
**Usage:**
|
|
127
|
+
**Usage:** funding-cta, sponsor-badge, sponsor-button
|
|
128
128
|
**Rules:** Use for prominent Sponsors CTAs. Pair with fgColor.onEmphasis for text.
|
|
129
129
|
|
|
130
130
|
### bgColor-sponsors-muted
|
|
131
131
|
Subtle background for GitHub Sponsors content
|
|
132
|
-
**Usage:** sponsor-card, sponsor-highlight
|
|
132
|
+
**Usage:** funding-prompt, sponsor-card, sponsor-highlight
|
|
133
133
|
**Rules:** Use for GitHub Sponsors related content. Do NOT use for general pink-colored elements.
|
|
134
134
|
|
|
135
135
|
### bgColor-success-emphasis
|
|
136
136
|
Strong success background for prominent positive actions
|
|
137
|
-
**Usage:**
|
|
137
|
+
**Usage:** confirm-action, merge-button, success-badge
|
|
138
138
|
**Rules:** Use for positive action buttons like merge or confirm. Pair with fgColor.onEmphasis for text.
|
|
139
139
|
|
|
140
140
|
### bgColor-success-muted
|
|
141
141
|
Subtle success background for positive feedback and completed states
|
|
142
|
-
**Usage:**
|
|
142
|
+
**Usage:** completed-state, positive-feedback, success-message
|
|
143
143
|
**Rules:** Use for success states and positive feedback. Pair with fgColor.success for text.
|
|
144
144
|
|
|
145
145
|
### bgColor-transparent
|
|
@@ -149,34 +149,34 @@ Fully transparent background
|
|
|
149
149
|
|
|
150
150
|
### bgColor-upsell-emphasis
|
|
151
151
|
Strong background for prominent upsell elements
|
|
152
|
-
**Usage:**
|
|
152
|
+
**Usage:** premium-badge, upgrade-button, upsell-cta
|
|
153
153
|
**Rules:** Use for prominent upgrade/upsell CTAs. Pair with fgColor.onEmphasis for text.
|
|
154
154
|
|
|
155
155
|
### bgColor-upsell-muted
|
|
156
156
|
Subtle background for upsell and promotional content
|
|
157
|
-
**Usage:**
|
|
157
|
+
**Usage:** premium-feature, promotional-banner, upgrade-prompt
|
|
158
158
|
**Rules:** Use for upgrade prompts and premium feature highlights. Do NOT use for regular content.
|
|
159
159
|
|
|
160
160
|
## BorderColor
|
|
161
161
|
|
|
162
162
|
### borderColor-accent-emphasis
|
|
163
163
|
Strong accent border for selected or focused elements
|
|
164
|
-
**Usage:** accent-emphasis,
|
|
164
|
+
**Usage:** accent-emphasis, focus-border, selected-border
|
|
165
165
|
**Rules:** Use for selected elements and focus states. Strong visual emphasis.
|
|
166
166
|
|
|
167
167
|
### borderColor-accent-muted
|
|
168
168
|
Subtle accent border for selected or focused elements
|
|
169
|
-
**Usage:** accent-muted,
|
|
169
|
+
**Usage:** accent-muted, info-muted, selected-muted
|
|
170
170
|
**Rules:** Use for accent-colored borders on selected elements. Pair with bgColor.accent.muted.
|
|
171
171
|
|
|
172
172
|
### borderColor-attention-emphasis
|
|
173
173
|
Strong attention border for prominent warnings
|
|
174
|
-
**Usage:** attention-emphasis,
|
|
174
|
+
**Usage:** attention-emphasis, caution-emphasis, warning-emphasis
|
|
175
175
|
**Rules:** Use for emphasized warning borders. Pair with bgColor.attention.emphasis.
|
|
176
176
|
|
|
177
177
|
### borderColor-attention-muted
|
|
178
178
|
Subtle attention border for warnings and caution states
|
|
179
|
-
**Usage:** attention-muted,
|
|
179
|
+
**Usage:** attention-muted, caution-muted, warning-muted
|
|
180
180
|
**Rules:** Use for warning state borders. Pair with bgColor.attention.muted.
|
|
181
181
|
|
|
182
182
|
### borderColor-closed-emphasis
|
|
@@ -186,22 +186,22 @@ Strong border for closed state badges
|
|
|
186
186
|
|
|
187
187
|
### borderColor-closed-muted
|
|
188
188
|
Subtle border for closed state indicators
|
|
189
|
-
**Usage:** closed-
|
|
189
|
+
**Usage:** closed-issue, closed-muted, closed-pr
|
|
190
190
|
**Rules:** Use for closed/declined status borders. Specifically for GitHub issues and PRs.
|
|
191
191
|
|
|
192
192
|
### borderColor-danger-emphasis
|
|
193
193
|
Strong danger border for destructive actions and errors
|
|
194
|
-
**Usage:** danger-emphasis,
|
|
194
|
+
**Usage:** danger-emphasis, destructive-emphasis, error-emphasis
|
|
195
195
|
**Rules:** MUST use for destructive action borders. Pair with bgColor.danger.emphasis.
|
|
196
196
|
|
|
197
197
|
### borderColor-danger-muted
|
|
198
198
|
Subtle danger border for errors and destructive contexts
|
|
199
|
-
**Usage:** danger-muted,
|
|
199
|
+
**Usage:** danger-muted, destructive-muted, error-muted
|
|
200
200
|
**Rules:** Use for error state borders. Pair with bgColor.danger.muted.
|
|
201
201
|
|
|
202
202
|
### borderColor-default
|
|
203
203
|
Default border color for most UI elements
|
|
204
|
-
**Usage:**
|
|
204
|
+
**Usage:** card-border, default-border, divider, input-border
|
|
205
205
|
**Rules:** RECOMMENDED default for all borders. Use for cards, inputs, and dividers.
|
|
206
206
|
|
|
207
207
|
### borderColor-disabled
|
|
@@ -216,7 +216,7 @@ Strong border for completed/done state badges
|
|
|
216
216
|
|
|
217
217
|
### borderColor-done-muted
|
|
218
218
|
Subtle border for completed/done state indicators
|
|
219
|
-
**Usage:** done-muted, merged
|
|
219
|
+
**Usage:** completed, done-muted, merged
|
|
220
220
|
**Rules:** Use for completed/done status borders. Conveys finished or merged state.
|
|
221
221
|
|
|
222
222
|
### borderColor-draft-emphasis
|
|
@@ -226,17 +226,17 @@ Strong border for draft state badges
|
|
|
226
226
|
|
|
227
227
|
### borderColor-draft-muted
|
|
228
228
|
Subtle border for draft state indicators
|
|
229
|
-
**Usage:** draft-
|
|
229
|
+
**Usage:** draft-issue, draft-muted, draft-pr
|
|
230
230
|
**Rules:** Use for draft/WIP status borders. Conveys incomplete or pending state.
|
|
231
231
|
|
|
232
232
|
### borderColor-emphasis
|
|
233
233
|
Strong border for emphasis and visual weight
|
|
234
|
-
**Usage:** emphasis-border,
|
|
234
|
+
**Usage:** emphasis-border, selected-border, strong-border
|
|
235
235
|
**Rules:** Use for borders needing more visual weight. Darker than borderColor.default.
|
|
236
236
|
|
|
237
237
|
### borderColor-muted
|
|
238
238
|
Subtle border for secondary elements and light separators
|
|
239
|
-
**Usage:**
|
|
239
|
+
**Usage:** light-divider, secondary-border, subtle-border
|
|
240
240
|
**Rules:** Use for subtle borders and separators. Less prominent than borderColor.default.
|
|
241
241
|
|
|
242
242
|
### borderColor-neutral-emphasis
|
|
@@ -256,7 +256,7 @@ Strong border for open state badges
|
|
|
256
256
|
|
|
257
257
|
### borderColor-open-muted
|
|
258
258
|
Subtle border for open state indicators
|
|
259
|
-
**Usage:** open-
|
|
259
|
+
**Usage:** open-issue, open-muted, open-pr
|
|
260
260
|
**Rules:** Use for open/active status borders. Specifically for GitHub issues and PRs.
|
|
261
261
|
|
|
262
262
|
### borderColor-severe-emphasis
|
|
@@ -271,22 +271,22 @@ Subtle severe border for high-priority warnings
|
|
|
271
271
|
|
|
272
272
|
### borderColor-sponsors-emphasis
|
|
273
273
|
Strong border for prominent GitHub Sponsors elements
|
|
274
|
-
**Usage:**
|
|
274
|
+
**Usage:** funding-emphasis, sponsors-emphasis
|
|
275
275
|
**Rules:** Use for emphasized Sponsors borders. Pair with bgColor.sponsors.emphasis.
|
|
276
276
|
|
|
277
277
|
### borderColor-sponsors-muted
|
|
278
278
|
Subtle border for GitHub Sponsors content
|
|
279
|
-
**Usage:**
|
|
279
|
+
**Usage:** funding-muted, sponsors-muted
|
|
280
280
|
**Rules:** Use for GitHub Sponsors related borders. Do NOT use for general pink-colored elements.
|
|
281
281
|
|
|
282
282
|
### borderColor-success-emphasis
|
|
283
283
|
Strong success border for prominent positive elements
|
|
284
|
-
**Usage:**
|
|
284
|
+
**Usage:** confirmed, positive-emphasis, success-emphasis
|
|
285
285
|
**Rules:** Use for emphasized success borders. Pair with bgColor.success.emphasis.
|
|
286
286
|
|
|
287
287
|
### borderColor-success-muted
|
|
288
288
|
Subtle success border for positive feedback elements
|
|
289
|
-
**Usage:**
|
|
289
|
+
**Usage:** positive-muted, success-muted, valid-muted
|
|
290
290
|
**Rules:** Use for success state borders. Pair with bgColor.success.muted.
|
|
291
291
|
|
|
292
292
|
### borderColor-translucent
|
|
@@ -296,95 +296,104 @@ Semi-transparent border for overlays and layered elements
|
|
|
296
296
|
|
|
297
297
|
### borderColor-upsell-emphasis
|
|
298
298
|
Strong border for prominent upsell elements
|
|
299
|
-
**Usage:**
|
|
299
|
+
**Usage:** premium-emphasis, upsell-emphasis
|
|
300
300
|
**Rules:** Use for emphasized upsell borders. Pair with bgColor.upsell.emphasis.
|
|
301
301
|
|
|
302
302
|
### borderColor-upsell-muted
|
|
303
303
|
Subtle border for upsell and promotional content
|
|
304
|
-
**Usage:**
|
|
304
|
+
**Usage:** premium-muted, upsell-muted
|
|
305
305
|
**Rules:** Use for upgrade prompts and premium feature borders. Do NOT use for regular content.
|
|
306
306
|
|
|
307
307
|
## BorderRadius
|
|
308
308
|
|
|
309
309
|
### borderRadius-full
|
|
310
310
|
Use this border radius for pill shaped elements
|
|
311
|
-
**Usage:** avatar,
|
|
311
|
+
**Usage:** avatar, circular-button, pill-badge
|
|
312
312
|
**Rules:** Use for avatars and pill-shaped elements. Do NOT use for rectangular containers.
|
|
313
313
|
|
|
314
314
|
### borderRadius-large
|
|
315
315
|
Large border radius (12px). Use for larger containers, dialogs, or when more visual softness is desired. Always use this for buttons.
|
|
316
|
-
**Usage:**
|
|
316
|
+
**Usage:** card, dialog, modal
|
|
317
317
|
**Rules:** Recommended for dialogs and modals.
|
|
318
318
|
|
|
319
319
|
### borderRadius-medium
|
|
320
320
|
Medium border radius (6px). The default choice for most buttons, cards, and containers
|
|
321
|
-
**Usage:** button,
|
|
321
|
+
**Usage:** button, card, container, input, select, textarea
|
|
322
322
|
**Rules:** Default choice for most components. Use for inputs, cards, and general containers.
|
|
323
323
|
|
|
324
324
|
### borderRadius-small
|
|
325
325
|
Small border radius (3px). Use for small variants of components or small UI elements like badges, tags, or anything below 16px in height
|
|
326
|
-
**Usage:** badge,
|
|
326
|
+
**Usage:** badge, label, small-input, tag
|
|
327
327
|
**Rules:** Use for small UI elements under 16px height. Do NOT use for buttons or cards.
|
|
328
328
|
|
|
329
329
|
## BorderWidth
|
|
330
330
|
|
|
331
331
|
### borderWidth-thick
|
|
332
332
|
Thick 2px border for emphasis. Use for focus indicators, selected states, or to emphasize important boundaries
|
|
333
|
-
**Usage:** focus-indicator, selected-state
|
|
333
|
+
**Usage:** emphasis-border, focus-indicator, selected-state
|
|
334
334
|
**Rules:** MUST use for focus rings on interactive elements. Do NOT use for subtle dividers.
|
|
335
335
|
|
|
336
|
+
## Data
|
|
337
|
+
|
|
338
|
+
Colors for data visualization including charts, graphs, and diagrams. Use these colors to differentiate data series. Emphasis variants are for lines, bars, and borders. Muted variants are for area fills and backgrounds.
|
|
339
|
+
|
|
340
|
+
**Usage:** area-chart, bar-fill, chart-series, data-point, graph-line, pie-segment
|
|
341
|
+
**Rules:** Use data colors for visualizations only. Do NOT use for semantic meaning (use bgColor.success/danger instead). When using multiple series, ensure sufficient contrast between adjacent colors. Pair emphasis with muted variants of the same color for cohesive styling.
|
|
342
|
+
|
|
343
|
+
**Tokens:** data-auburn-color-emphasis, data-auburn-color-muted, data-blue-color-emphasis, data-blue-color-muted, data-brown-color-emphasis, data-brown-color-muted, data-coral-color-emphasis, data-coral-color-muted, data-gray-color-emphasis, data-gray-color-muted, data-green-color-emphasis, data-green-color-muted, data-lemon-color-emphasis, data-lemon-color-muted, data-lime-color-emphasis, data-lime-color-muted, data-olive-color-emphasis, data-olive-color-muted, data-orange-color-emphasis, data-orange-color-muted, data-pine-color-emphasis, data-pine-color-muted, data-pink-color-emphasis, data-pink-color-muted, data-plum-color-emphasis, data-plum-color-muted, data-purple-color-emphasis, data-purple-color-muted, data-red-color-emphasis, data-red-color-muted, data-teal-color-emphasis, data-teal-color-muted, data-yellow-color-emphasis, data-yellow-color-muted
|
|
344
|
+
|
|
336
345
|
## Easing
|
|
337
346
|
|
|
338
347
|
### base-easing-ease
|
|
339
348
|
CSS default easing. Use for hover state changes and micro-interactions.
|
|
340
|
-
**Usage:** hover
|
|
349
|
+
**Usage:** button-hover, hover-state, link-hover, micro-interaction
|
|
341
350
|
**Rules:** Use for hover state changes.
|
|
342
351
|
|
|
343
352
|
### base-easing-easeIn
|
|
344
353
|
Accelerating motion. Use for elements exiting the viewport (moving off-screen).
|
|
345
|
-
**Usage:**
|
|
354
|
+
**Usage:** element-leaving, exit-animation, off-screen-motion
|
|
346
355
|
**Rules:** Rarely used alone. Prefer ease-out for most exit animations.
|
|
347
356
|
|
|
348
357
|
### base-easing-easeInOut
|
|
349
358
|
Smooth acceleration and deceleration. Use for elements moving or morphing within the viewport.
|
|
350
|
-
**Usage:**
|
|
359
|
+
**Usage:** expand-collapse, morph-animation, position-change, size-change, slide-transition
|
|
351
360
|
**Rules:** Use if an element moves or morphs on screen.
|
|
352
361
|
|
|
353
362
|
### base-easing-easeOut
|
|
354
363
|
Decelerating motion. Use for elements entering the viewport or appearing on screen.
|
|
355
|
-
**Usage:**
|
|
364
|
+
**Usage:** dropdown-open, element-appearing, enter-animation, modal-open, tooltip-appear
|
|
356
365
|
**Rules:** RECOMMENDED default. Use if an element enters or exits the viewport.
|
|
357
366
|
|
|
358
367
|
### base-easing-linear
|
|
359
368
|
Constant motion with no acceleration. Use for continuous animations like progress bars or loaders.
|
|
360
|
-
**Usage:**
|
|
369
|
+
**Usage:** continuous-animation, loader, progress-bar, scrolling
|
|
361
370
|
**Rules:** Use if the motion is constant.
|
|
362
371
|
|
|
363
372
|
## text and foreground color
|
|
364
373
|
|
|
365
374
|
### fgColor-accent
|
|
366
375
|
Accent text for links and interactive elements
|
|
367
|
-
**Usage:** accent-
|
|
376
|
+
**Usage:** accent-icon, accent-text, info-text
|
|
368
377
|
**Rules:** Use for accent-colored text and icons. Pair with bgColor.accent.muted for backgrounds.
|
|
369
378
|
|
|
370
379
|
### fgColor-attention
|
|
371
380
|
Attention text for warnings and caution states
|
|
372
|
-
**Usage:** attention-text,
|
|
381
|
+
**Usage:** attention-text, caution-text, warning-text
|
|
373
382
|
**Rules:** Use for warning and caution text. Pair with bgColor.attention.muted for backgrounds.
|
|
374
383
|
|
|
375
384
|
### fgColor-closed
|
|
376
385
|
Text color for closed state indicators (issues, PRs)
|
|
377
|
-
**Usage:** closed-
|
|
386
|
+
**Usage:** closed-issue, closed-pr, closed-text
|
|
378
387
|
**Rules:** Use for closed/declined status text. Specifically for GitHub issues and PRs.
|
|
379
388
|
|
|
380
389
|
### fgColor-danger
|
|
381
390
|
Danger text for errors and destructive actions
|
|
382
|
-
**Usage:** danger-text,
|
|
391
|
+
**Usage:** danger-text, destructive-text, error-text
|
|
383
392
|
**Rules:** Use for error messages and destructive action text. Pair with bgColor.danger.muted for backgrounds.
|
|
384
393
|
|
|
385
394
|
### fgColor-default
|
|
386
395
|
Default text color for primary content and headings
|
|
387
|
-
**Usage:** default-text, heading
|
|
396
|
+
**Usage:** body-text, default-text, heading
|
|
388
397
|
**Rules:** RECOMMENDED default for all text. Use for headings, body text, and primary labels.
|
|
389
398
|
|
|
390
399
|
### fgColor-disabled
|
|
@@ -394,22 +403,22 @@ Text color for disabled interactive elements
|
|
|
394
403
|
|
|
395
404
|
### fgColor-done
|
|
396
405
|
Text color for completed/done state indicators
|
|
397
|
-
**Usage:** done-text, merged
|
|
406
|
+
**Usage:** completed, done-text, merged
|
|
398
407
|
**Rules:** Use for completed/done status text. Conveys finished or merged state.
|
|
399
408
|
|
|
400
409
|
### fgColor-draft
|
|
401
410
|
Text color for draft state indicators
|
|
402
|
-
**Usage:** draft-
|
|
411
|
+
**Usage:** draft-issue, draft-pr, draft-text
|
|
403
412
|
**Rules:** Use for draft/WIP status text. Conveys incomplete or pending state.
|
|
404
413
|
|
|
405
414
|
### fgColor-link
|
|
406
415
|
Text color for hyperlinks
|
|
407
|
-
**Usage:** link-text
|
|
416
|
+
**Usage:** hyperlink, link-text
|
|
408
417
|
**Rules:** MUST use for all text links. Provides expected link affordance.
|
|
409
418
|
|
|
410
419
|
### fgColor-muted
|
|
411
420
|
Muted text for secondary content and less important information
|
|
412
|
-
**Usage:**
|
|
421
|
+
**Usage:** helper-text, muted-text, placeholder, secondary-text
|
|
413
422
|
**Rules:** Use for secondary text like timestamps, metadata, and helper text. Do NOT use for primary content.
|
|
414
423
|
|
|
415
424
|
### fgColor-neutral
|
|
@@ -419,44 +428,51 @@ Neutral semantic text for icons and secondary elements
|
|
|
419
428
|
|
|
420
429
|
### fgColor-onEmphasis
|
|
421
430
|
Text color for use on emphasis backgrounds
|
|
422
|
-
**Usage:** text-on-emphasis
|
|
431
|
+
**Usage:** contrast-text, text-on-emphasis
|
|
423
432
|
**Rules:** MUST use for text on any emphasis background (bgColor.*.emphasis). Ensures accessibility contrast.
|
|
424
433
|
|
|
425
434
|
### fgColor-onInverse
|
|
426
435
|
Text color for use on inverse backgrounds
|
|
427
|
-
**Usage:** text-on-inverse
|
|
436
|
+
**Usage:** inverse-text, text-on-inverse
|
|
428
437
|
**Rules:** Use for text on bgColor.inverse. Provides appropriate contrast in both themes.
|
|
429
438
|
|
|
430
439
|
### fgColor-open
|
|
431
440
|
Text color for open state indicators (issues, PRs)
|
|
432
|
-
**Usage:** open-
|
|
441
|
+
**Usage:** open-issue, open-pr, open-text
|
|
433
442
|
**Rules:** Use for open/active status text. Specifically for GitHub issues and PRs.
|
|
434
443
|
|
|
435
444
|
### fgColor-severe
|
|
436
445
|
Severe text for high-priority warnings
|
|
437
|
-
**Usage:** severe-
|
|
446
|
+
**Usage:** severe-icon, severe-text, urgent-text
|
|
438
447
|
**Rules:** Use for severe warnings, less critical than danger. Pair with bgColor.severe.muted for backgrounds.
|
|
439
448
|
|
|
440
449
|
### fgColor-sponsors
|
|
441
450
|
Text color for GitHub Sponsors content
|
|
442
|
-
**Usage:**
|
|
451
|
+
**Usage:** funding-text, sponsors-icon, sponsors-text
|
|
443
452
|
**Rules:** Use for GitHub Sponsors related text. Do NOT use for general pink-colored text.
|
|
444
453
|
|
|
445
454
|
### fgColor-success
|
|
446
455
|
Success text for positive feedback and completed states
|
|
447
|
-
**Usage:**
|
|
456
|
+
**Usage:** positive-text, success-icon, success-text
|
|
448
457
|
**Rules:** Use for success states and positive feedback text. Pair with bgColor.success.muted for backgrounds.
|
|
449
458
|
|
|
450
459
|
### fgColor-upsell
|
|
451
460
|
Text color for upsell and promotional content
|
|
452
|
-
**Usage:**
|
|
461
|
+
**Usage:** premium-text, promotional, upsell-text
|
|
453
462
|
**Rules:** Use for upgrade prompts and premium feature text. Do NOT use for regular content.
|
|
454
463
|
|
|
464
|
+
## Focus
|
|
465
|
+
|
|
466
|
+
### focus-outlineColor
|
|
467
|
+
Outline color for focus states on interactive elements
|
|
468
|
+
**Usage:** accessibility-indicator, focus-ring, keyboard-navigation
|
|
469
|
+
**Rules:** Use for focus outlines on interactive elements like buttons, links, and form controls. MUST be visible for keyboard navigation accessibility. Do NOT use for decorative borders or non-interactive elements.
|
|
470
|
+
|
|
455
471
|
## FontStack
|
|
456
472
|
|
|
457
473
|
### fontStack-monospace
|
|
458
474
|
Monospace font stack for code, technical content, and tabular data.
|
|
459
|
-
**Usage:** code-block, inline-code,
|
|
475
|
+
**Usage:** code-block, inline-code, tabular-numbers, technical-data, terminal
|
|
460
476
|
**Rules:** MUST use for all code display. Use for technical content requiring fixed-width characters.
|
|
461
477
|
|
|
462
478
|
### fontStack-sansSerif
|
|
@@ -466,58 +482,65 @@ Sans-serif font stack for body text and general UI elements.
|
|
|
466
482
|
|
|
467
483
|
### fontStack-sansSerifDisplay
|
|
468
484
|
Display font stack for headings and titles. Same as sansSerif but semantically distinct.
|
|
469
|
-
**Usage:**
|
|
485
|
+
**Usage:** display-text, heading, hero-text, title
|
|
470
486
|
**Rules:** Use for headings and display text. Prefer over sansSerif for titles.
|
|
471
487
|
|
|
472
488
|
## Outline
|
|
473
489
|
|
|
474
490
|
### outline-focus-width
|
|
475
491
|
Focus outline width (2px). Standard width for keyboard focus indicators to meet WCAG 2.4.7 accessibility requirements
|
|
476
|
-
**Usage:** focus-ring, keyboard-focus
|
|
492
|
+
**Usage:** accessibility, focus-ring, keyboard-focus
|
|
477
493
|
**Rules:** MUST use for all keyboard focus indicators. Required for WCAG 2.4.7 compliance.
|
|
478
494
|
|
|
495
|
+
## Selection
|
|
496
|
+
|
|
497
|
+
### selection-bgColor
|
|
498
|
+
Background color for text selection highlights
|
|
499
|
+
**Usage:** highlighted-text, selected-content, text-selection
|
|
500
|
+
**Rules:** Use for native text selection (::selection) and programmatic text highlighting. Do NOT use for general emphasis or background colors on containers.
|
|
501
|
+
|
|
479
502
|
## Shadow
|
|
480
503
|
|
|
481
504
|
### shadow-floating-large
|
|
482
505
|
Large floating shadow for modals and dialogs
|
|
483
|
-
**Usage:**
|
|
506
|
+
**Usage:** dialog, full-screen-overlay, modal
|
|
484
507
|
**Rules:** MUST use for modals and dialogs. Do NOT use for small floating elements.
|
|
485
508
|
|
|
486
509
|
### shadow-floating-small
|
|
487
510
|
Small floating shadow for dropdowns, tooltips, and small overlays
|
|
488
|
-
**Usage:** dropdown,
|
|
511
|
+
**Usage:** dropdown, menu, popover, tooltip
|
|
489
512
|
**Rules:** Use for small floating elements like dropdowns and tooltips. Do NOT use for modals or dialogs.
|
|
490
513
|
|
|
491
514
|
## Text
|
|
492
515
|
|
|
493
516
|
### text-body-shorthand-large
|
|
494
517
|
User-generated content, markdown rendering.
|
|
495
|
-
**Usage:**
|
|
518
|
+
**Usage:** article-text, comment-body, markdown-content, readme
|
|
496
519
|
**Rules:** Use for user-generated content and markdown. Better readability for longer text.
|
|
497
520
|
|
|
498
521
|
### text-body-shorthand-medium
|
|
499
522
|
Default UI font. Most commonly used for body text.
|
|
500
|
-
**Usage:** body-text,
|
|
523
|
+
**Usage:** body-text, button-text, form-label, navigation, ui-text
|
|
501
524
|
**Rules:** RECOMMENDED default for UI text. Use for buttons, labels, and general interface text.
|
|
502
525
|
|
|
503
526
|
### text-body-shorthand-small
|
|
504
527
|
Small body text for discrete UI applications, such as helper, footnote text. Should be used sparingly across pages. Line-height matches Body (medium) at 20px.
|
|
505
|
-
**Usage:** helper-text,
|
|
528
|
+
**Usage:** footnote, helper-text, metadata, timestamp
|
|
506
529
|
**Rules:** Use sparingly for secondary information. Do NOT use for primary content or interactive elements.
|
|
507
530
|
|
|
508
531
|
### text-caption-shorthand
|
|
509
532
|
Compact small font with a smaller line height of 16px. Use it for single-line scenarios, as the small sizing doesn’t pass accessibility requirements.
|
|
510
|
-
**Usage:** caption, label,
|
|
533
|
+
**Usage:** badge-text, caption, label, single-line-metadata
|
|
511
534
|
**Rules:** Use only for single-line or short text. Does NOT meet accessibility requirements for body text.
|
|
512
535
|
|
|
513
536
|
### text-codeBlock-shorthand
|
|
514
537
|
Default style for rendering code blocks.
|
|
515
|
-
**Usage:** code-block,
|
|
538
|
+
**Usage:** code-block, code-snippet, pre-element, terminal-output
|
|
516
539
|
**Rules:** MUST use for multi-line code. Use monospace font stack.
|
|
517
540
|
|
|
518
541
|
### text-codeInline-shorthand
|
|
519
542
|
Inline code blocks using em units to inherit size from its parent.
|
|
520
|
-
**Usage:**
|
|
543
|
+
**Usage:** code-element, command, inline-code, variable-name
|
|
521
544
|
**Rules:** Use for inline code within text. Size inherits from parent using em units.
|
|
522
545
|
|
|
523
546
|
### text-display-shorthand
|
|
@@ -527,20 +550,20 @@ Hero-style text for brand to product transition pages. Utilize Title (large) sty
|
|
|
527
550
|
|
|
528
551
|
### text-subtitle-shorthand
|
|
529
552
|
Page sections/sub headings, or less important object names in page titles (automated action titles, for example). Same line-height as title (medium).
|
|
530
|
-
**Usage:**
|
|
553
|
+
**Usage:** description, lead-text, secondary-heading, subtitle
|
|
531
554
|
**Rules:** Use below titles for supporting text. Normal weight distinguishes from title styles.
|
|
532
555
|
|
|
533
556
|
### text-title-shorthand-large
|
|
534
557
|
Page headings for user-created objects, such as issues or pull requests. Utilize title (medium) styles on narrow viewports.
|
|
535
|
-
**Usage:**
|
|
558
|
+
**Usage:** h1, issue-title, page-heading, pr-title
|
|
536
559
|
**Rules:** Use for primary page headings. Switch to title.medium on narrow viewports.
|
|
537
560
|
|
|
538
561
|
### text-title-shorthand-medium
|
|
539
562
|
Default page title. The 32px-equivalent line-height matches with button and other medium control heights. Great for page header composition.
|
|
540
|
-
**Usage:**
|
|
563
|
+
**Usage:** card-title, dialog-title, h2, section-heading
|
|
541
564
|
**Rules:** RECOMMENDED default for page titles. Use for section headings and dialog titles.
|
|
542
565
|
|
|
543
566
|
### text-title-shorthand-small
|
|
544
567
|
Uses the same size as body (large) with a heavier weight of semibold (600).
|
|
545
|
-
**Usage:**
|
|
568
|
+
**Usage:** h3, list-title, sidebar-heading, subsection-heading
|
|
546
569
|
**Rules:** Use for smaller headings within sections. Same size as body.large but semibold.
|