Utilities
Outline
Set width and color of an item’s outline
CSS properties
Note: The outline utilities apply a solid outline of specified width.
Utility mixins
Utilities may be used in component Sass with utility mixins. Highlighted tokens are the USWDS design tokens that serve as the foundation for all design system styles. Each token is also a documentation link. Consult the Design tokens section for more information on tokens and how to use them in USWDS.
| Utility | Mixin | Example |
|---|---|---|
| .outline-units | u-outline(units) | @include u-outline('05') |
| .outline-color-color | u-outline-color(color) | @include u-outline-color('gold-30v') |
Using utility mixins
- Use single-quoted strings in utility mixins. Do not quote numbers or px values, with the exception of half (
05) values like'05','105', and'205'which should be treated as strings. - String tokens for half values (
05) and negative values (likeneg-1)may also be written with their unquoted number token equivalent:0.5,1.5,2.5,2.5,-1,-1.5, etc - If multiple utilities share the same prefix (ex:
.text-or.flex-) or a single utility accepts multiple kinds of values (ex:.borderaccepts both border weight and border color), their shared mixin can accept multiple comma-separated values:u-text('primary-darkest', 'no-underline', 'bold')oru-border-top(2px, 'accent-warm'). - Output any utility mixin as
!importantby appending!importantto the mixin’s argument list:u-bg('red-warm-50v', !important).
Advanced settings
Responsive variants
Add a responsive breakpoint prefix separated with a : to target a utility at a responsive breakpoint and higher, following a mobile-first methodology.
Example
.tablet:padding-y-2
Output
@media screen and (min-width: 640px) {
.tablet\:padding-y-2 {
padding-top: 1rem;
padding-bottom: 1rem;
}
}
Set up which breakpoints are available to USWDS utilities by setting the $theme-utility-breakpoints variable in your USWDS settings configuration.
| Breakpoint name | Width | Default |
|---|---|---|
| card | 160px | false |
| card-lg | 240px | false |
| mobile | 320px | false |
| mobile-lg | 480px | true |
| tablet | 640px | true |
| tablet-lg | 880px | false |
| desktop | 1024px | true |
| desktop-lg | 1200px | false |
| widescreen | 1400px | false |
Set whether a utility family outputs with responsive variants by setting the value of $[utility_family]-settings.responsive in your USWDS settings configuration. When modifying settings stored as a map, undefined map elements will keep their default values.
Example
@use "uswds-core" with (
$background-color-settings: (
responsive: true
)
);
| Utility variable | Default |
|---|---|
| $outline-settings.responsive | false |
| $outline-color-settings.responsive | false |
State variants
Use a state prefix separated with a : to target a utility in a specific state.
Example
.hover:bg-primary-vivid
Output
.hover\:bg-primary-vivid:hover { background-color: #0052de; }
Set whether a utility outputs a specific state variant by setting the value of the $[utility_family]-settings.[state] variable in your USWDS settings configuration. When modifying settings stored as a map, undefined map elements will keep their default values.
Example
@use "uswds-core" with (
$background-color-settings: (
active: true
)
);
| Utility variable | active | focus | hover | visited |
|---|---|---|---|---|
| $outline-settings | false | false | false | false |
| $outline-color-settings | false | false | false | false |
Output control
Control whether or not to output any USWDS utility family by setting the value of the $[utility_family]-settings.output variable in your USWDS settings configuration.
A value of true will output the utility family and any variants. A value of false prevents the output of the family and any variants.
| Utility variable | Default |
|---|---|
| $outline-settings.output | true |
| $outline-color-settings.output | true |
Custom values
By default, USWDS utilities output the standard values listed in the standard output table. Customize and refine any utility family’s specific values by editing the $[utility_family]-manual-values and $[utility_family]-palettes variables in your USWDS settings configuration.
Manual values
Specify manual values as unique key:value pairs using the $[utility_family]-manual-values map, where the key is the utility’s value suffix, and the value is what the utility will output.
Example
$width-manual-values: ( 'tab': 4ch, );
Output
.width-tab { width: 4ch; }
Palettes
Palettes are predefined groups of values. Add palettes to the $[utility_family]-palettes list variable in your USWDS settings configuration to add those values to the utility family.
Example
$outline-color-palettes: ( 'palette-color-red-medium', 'palette-color-red-medium-vivid' // note: no trailing comma );
Output
.outline-red-40 { outline-color: #ed6b61; }
.outline-red-50 { outline-color: #d83731; }
.outline-red-60 { outline-color: #ab3a3a; }
.outline-red-40v { outline-color: #ff5c48; }
.outline-red-50v { outline-color: #e82207; }
.outline-red-60v { outline-color: #c31f0a; }
Color palettes
In the following table, family indicates a specific unquoted system color family token (like blue-warm) as documented on the system color tokens page.
| Palette name | Palette contents |
|---|---|
| 'palette-color' | All color tokens |
| 'palette-color-default' | System default color tokens |
| 'palette-color-theme' | All theme color tokens |
| 'palette-color-state' | All state color tokens |
| 'palette-color-grayscale' | gray-5, gray-10, gray-30, gray-50, gray-70, gray-90 |
| 'palette-color-basic' | All basic colors |
| 'palette-color-system' | All grades in all system color tokens |
| 'palette-color-system-family' | All grades in the specified family |
| 'palette-color-system-family-light' | Grades 5, 10, 20, 30 |
| 'palette-color-system-family-light-vivid' | Grades 5v, 10v, 20v, 30v |
| 'palette-color-system-family-medium' | Grades 40, 50, 60 |
| 'palette-color-system-family-medium-vivid' | Grades 40v, 50v, 60v |
| 'palette-color-system-family-dark' | Grades 70, 80, 90 |
| 'palette-color-system-family-dark-vivid' | Grades 70v, 80v, 90v |
| 'palette-color-system-family-standard' | Grades 5, 10, 20, 30, 40, 50, 60, 70, 80, 90 |
| 'palette-color-system-family-vivid' | Grades 5v, 10v, 20v, 30v, 40v, 50v, 60v, 70v, 80v, 90v |
Spacing and units
| Palette name | Palette contents |
|---|---|
| 'palette-units' | All spacing unit tokens (system, ch, em, percentage) |
| 'palette-units-system' | All system spacing unit tokens |
| 'palette-units-system-breakpoints' | All named spacing unit tokens: card, card-lg, mobile, mobile-lg, tablet, tablet-lg, desktop, desktop-lg, widescreen |
| 'palette-units-system-positive' | All positive spacing unit tokens |
| 'palette-units-system-positive-smaller' | 1px, 2px |
| 'palette-units-system-positive-small' | 05, 1, 105, 2, 205, 3 |
| 'palette-units-system-positive-medium' | 4, 5, 6, 7, 8, 9, 10, 15 |
| 'palette-units-system-positive-large' | card, card-lg, mobile |
| 'palette-units-system-positive-larger' | mobile-lg, tablet, tablet-lg |
| 'palette-units-system-positive-largest' | desktop, desktop-lg, widescreen |
| 'palette-units-system-negative' | All negative spacing values |
| 'palette-units-system-negative-smaller' | neg-1px, neg-2px |
| 'palette-units-system-negative-small' | neg-05, neg-1, neg-105, neg-2, neg-205, neg-3 |
| 'palette-units-ch' | 05ch, 1ch, 105ch, 2ch, 3ch, 4ch, 5ch, neg-05ch, neg-1ch, neg-105ch, neg-2ch, neg-3ch, neg-4ch, neg-5ch |
| 'palette-units-ch-positive' | 05ch, 1ch, 105ch, 2ch, 3ch, 4ch, 5ch |
| 'palette-units-ch-negative' | neg-05ch, neg-1ch, neg-105ch, neg-2ch, neg-3ch, neg-4ch, neg-5ch |
| 'palette-units-em' | 05em, 1em, 105em, 2em, 3em, 4em, 5em, 6em, 7em, 8em, 9em, 10em |
| 'palette-units-percentage' | 10ct, 20ct, 25ct, 30ct, 33ct, 40ct, 50ct, 60ct, 66ct, 75ct, 80ct, 90ct, 100ct |
| 'palette-units-0' | 0 |
