1
1
mirror of https://github.com/primer/css.git synced 2024-12-20 12:42:07 +03:00
css/modules/primer-utilities/docs/colors.md

7.9 KiB

title status status_issue
Colors New release https://github.com/github/design-systems/issues/97

Use color utilities to apply color to the background of elements, text, and borders.

Background colors

Background colors are most commonly used for filling large blocks of content or areas with a color. When selecting a background color, make sure the foreground color contrast passes a minimum WCAG accessibility rating of level AA. Meeting these standards ensures that content is accessible by everyone, regardless of disability or user device. You can check your color combination with this demo site. For more information, read our accessibility standards.

Gray

.bg-gray
#f5f5f5, $bg-gray
.bg-gray-dark
#333, $bg-gray-dark
.bg-gray-light
#fafafa, $bg-gray-light

Blue

.bg-blue
#4078c0, $bg-blue
.bg-blue-light
#f2f8fa, $bg-blue-light

Yellow

.bg-yellow
#ffd36b, $bg-yellow
.bg-yellow-light
#fff9ea, $bg-yellow-light

Red

.bg-red
#bd2c00, $bg-red
.bg-red-light
#fcdede, $bg-red-light

Green

.bg-green
#6cc644, $bg-green
.bg-green-light
#eaffea, $bg-green-light

Purple

.bg-purple
#6e5494, $bg-purple
.bg-purple-light
#f5f0ff, $bg-purple-light

Text colors

Use text color utilities to set text or octicons to a specific color. Color contrast must pass a minimum WCAG accessibility rating of level AA. This ensures that viewers who cannot see the full color spectrum are able to read the text. To customize outside of the suggested combinations below, we recommend using this color contrast testing tool. For more information, read our accessibility standards.

These are our most common text with background color combinations. They don't all pass accessibility standards currently, but will be updated in the future. Any of the combinations with a warning icon must be used with caution.

Text color inheritance

You can set the color inheritance on an element by using the text-inherit class.

<div class="text-purple">
  This text is purple, <a href="#" class="text-inherit">including the link</a>
</div>

Text on white background

<div class="text-blue mb-2">
  .text-blue on white
</div>
<div class="text-gray-dark mb-2">
  .text-gray-dark on white
</div>
<div class="text-gray mb-2">
  .text-gray on white
</div>
<div class="text-red mb-2">
  .text-red on white
</div>
<div class="text-orange mb-2">
  .text-orange on white
</div>
<span class="float-left text-red tooltipped tooltipped-n" aria-label="Does not meet accessibility standards"><%= octicon("alert") %></span>
<div class="text-orange-light mb-2">
  .text-orange-light on white
</div>
<span class="float-left text-red tooltipped tooltipped-n" aria-label="Does not meet accessibility standards"><%= octicon("alert") %></span>
<div class="text-green mb-2 ml-4">
  .text-green on white
</div>
<div class="text-purple mb-2">
  .text-purple on white
</div>

Text on colored backgrounds

<div class="text-white bg-blue mb-2">
  .text-white on .bg-blue
</div>
<div class="bg-blue-light mb-2">
  .text-gray-dark on .bg-blue-light
</div>
<div class="text-white bg-red mb-2">
  .text-white on .bg-red
</div>
<div class="text-red bg-red-light mb-2">
  .text-red on .bg-red-light
</div>
<div class="bg-green-light mb-2">
  .text-gray-dark on .bg-green-light
</div>
<div class="bg-yellow mb-2">
  .text-gray-dark on .bg-yellow
</div>
<div class="bg-yellow-light mb-2">
  .text-gray-dark on .bg-yellow-light
</div>
<div class="text-white bg-purple mb-2">
  .text-white on .bg-purple
</div>
<div class="text-white bg-gray-dark mb-2">
  .text-white on .bg-gray-dark
</div>
<div class="bg-gray">
  .text-gray-dark on .bg-gray
</div>

Base link styles turn links blue and apply an underline on hover. You can override the base link styles with text color utilities and the following link utilities. Bear in mind that link styles are easier for more people to see and interact with when the changes in styles do not rely on color alone.

Use link-gray to turn the link color to $text-gray and remain hover on blue.

<a class="link-gray" href="#url">link-gray</a>

Use link-gray-dark to turn the link color to $text-gray-dark and remain hover on blue.

<a class="link-gray-dark"  href="#url">link-gray-dark</a>

Use .muted-link to turn the link light gray in color, and blue on hover or focus with no underline.

<a class="muted-link" href="#url">muted-link</a>

Use link-hover-blue to make any text color used with links to turn blue on hover. This is useful when you want only part of a link to turn blue on hover.

<a class="text-gray-dark no-underline" href="#url">
  A link with only part of it is <span class="link-hover-blue">blue on hover</span>.
</a>

Border colors

Border colors are documented on the border utilities page.