Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up sass functions folder, add new functions for color contrast #628

Merged
merged 6 commits into from
Apr 4, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# [`master`](https://github.com/elastic/eui/tree/master)

- Modifying drop shadow intensities and color. ([607](https://github.com/elastic/eui/pull/607))
- Add Sass color functions. Make `$euiColorWarning` color usage more accessible while still being "yellow". ([628](https://github.com/elastic/eui/pull/628))

**Bug fixes**

Expand Down
21 changes: 12 additions & 9 deletions src/components/button/_button.scss
Original file line number Diff line number Diff line change
Expand Up @@ -78,21 +78,24 @@ $buttonTypes: (
// Create button modifiders based upon the map.
@each $name, $color in $buttonTypes {
.euiButton--#{$name} {
color: $color;

@if ($name == 'ghost') {
// Ghost is unique and ALWAYS sits against a dark background.
color: $color;
} @else {
// Other colors need to check their contrast against the page background color.
color: makeHighContrastColor($color, $euiColorEmptyShade);
}

border-color: $color;

&.euiButton--fill {
background-color: $color;
border-color: $color;

$textColor: #FFF;
@if ($name == 'ghost') {
$textColor: #000;
} @else if (lightness($euiTextColor) > 50) {
$textColor: $euiTextColor;
}
$fillTextColor: chooseLightOrDarkText($color, #FFF, #000);

color: $textColor;
color: $fillTextColor;

&:enabled {
&:hover, &:focus {
Expand All @@ -102,7 +105,7 @@ $buttonTypes: (
}

&:disabled .euiButton__spinner {
border-color: euiLoadingSpinnerBorderColors(transparentize($textColor, .3));
border-color: euiLoadingSpinnerBorderColors(transparentize($fillTextColor, .3));
}
}

Expand Down
9 changes: 5 additions & 4 deletions src/components/call_out/_call_out.scss
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,18 @@
$callOutTypes: (
primary: $euiColorPrimary,
success: $euiColorSecondary,
warning: adjust-hue($euiColorWarning, 20%),
warning: $euiColorWarning,
danger: $euiColorDanger,
);

// Create button modifiders based upon the map.
@each $name, $color in $callOutTypes {
.euiCallOut--#{$name} {
border-color: $color;
background-color: tintOrShade($color, 90%, 70%);
$backgroundColor: tintOrShade($color, 90%, 70%);
$textColor: makeHighContrastColor($color, $backgroundColor);

$textColor: shadeOrTint($color, 30%, 70%);
border-color: $color;
background-color: $backgroundColor;

.euiCallOutHeader__icon {
fill: $textColor;
Expand Down
6 changes: 4 additions & 2 deletions src/components/text/_text_color.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ $textColors: (
// Create color modifiers based on the map
@each $name, $color in $textColors {
.euiTextColor.euiTextColor--#{$name} {
color: $color !important;

// The below function makes sure the color is accessible on our default background.
color: makeHighContrastColor($color, $euiColorEmptyShade) !important;

// We need a blanket approach for coloring. It should overule everything.
* {
color: $color !important;
color: makeHighContrastColor($color, $euiColorEmptyShade) !important;
}
}
}
88 changes: 88 additions & 0 deletions src/global_styling/functions/_colors.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
// Mixes a provided color with white.
@function tint($color, $percent) {
@return mix(#fff, $color, $percent);
}

// Mixes a provided color with black.
@function shade($color, $percent) {
@return mix(#000, $color, $percent);
}

// For theming. Checks the text color and tells us whether it's light or dark.
// Based on that we either tint (add white) or shade (add black).
@function tintOrShade($color, $tint, $shade) {
@if (lightness($euiTextColor) > 50) {
@return shade($color, $shade);
} @else {
@return tint($color, $tint);
}
}

// The reverse of the above
@function shadeOrTint($color, $shade, $tint) {
@if (lightness($euiTextColor) < 50) {
@return shade($color, $shade);
} @else {
@return tint($color, $tint);
}
}

// Calculates luminance, which is better than brightness for checking colors
// pow, nth functions come from the _math.scss functions
@function luminance($color) {
// Formula: http://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef
$rgba: red($color), green($color), blue($color);
$rgba2: ();

@for $i from 1 through 3 {
$rgb: nth($rgba, $i);
$rgb: $rgb / 255;

$rgb: if($rgb < .03928, $rgb / 12.92, pow(($rgb + .055) / 1.055, 2.4));

$rgba2: append($rgba2, $rgb);
}

@return .2126 * nth($rgba2, 1) + .7152 * nth($rgba2, 2) + 0.0722 * nth($rgba2, 3);
}

// Calculate contrast
@function contrastRatio($background, $foreground) {
$backgroundLum: luminance($background) + .05;
$foregroundLum: luminance($foreground) + .05;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, why the + .05?

Copy link
Contributor Author

@snide snide Apr 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef

It's part of the formula for calculating contrast ratios when given relative luminance. To be honest, I barely understand how the math works, but I did check using @debug to make sure the value calculations along the functions work against WebAIM and other supported tools.


@return max($backgroundLum, $foregroundLum) / min($backgroundLum, $foregroundLum);
}

// Given $color, decide whether $lightText or $darkText should be used as the text color
// ex: chooseLightOrDarkText(#EEE, #FFF, #000) would return #000 because it has
// a higher contrast than #FFF against a #EEE background.
@function chooseLightOrDarkText($background, $lightText, $darkText) {
$lightContrast: contrastRatio($background, $lightText);
$darkContrast: contrastRatio($background, $darkText);

@if ($lightContrast > $darkContrast) {
@return $lightText;
}
@else {
@return $darkText;
}
}

// Given a $foreground and a $background, make the $foreground AA accessibility by slightly
// adjusting it till the contrast is high enough

// ex: makeContrastColor($lightPink, #FFF) would continually shade the pink until
// it had higher than 4.5 contrast on a white background.
@function makeHighContrastColor($foreground, $background) {
$contrast: contrastRatio($foreground, $background);

$highContrastTextColor: $foreground;

@while ($contrast < 4.5) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Someone more engineery might have a better way to do this, but it seems to work perfectly fine and outputs decent looking results. Basically keeps adjusting the shadeOrTint by 5% of a passed color until it gets passed 4.5.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems simple enough to me. Not sure what the load is on compilation but at 5% increments I don't think it should run too long.

$highContrastTextColor: shadeOrTint($highContrastTextColor, 5%, 5%);
$contrast: contrastRatio($highContrastTextColor, $euiColorEmptyShade);
}

@return $highContrastTextColor;
}
5 changes: 5 additions & 0 deletions src/global_styling/functions/_index.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// Math needs to be first in the load order
@import 'math';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you just add a comment in here that 'math' needs to come first to be used in all subsequent function files?


// Using math, we have functions to manipulate contrast / luminosity for accessibility
@import 'colors';
44 changes: 44 additions & 0 deletions src/global_styling/functions/_math.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Greatest common devisor
// From: http://rosettacode.org/wiki/Greatest_common_divisor#JavaScript
@function gcd($a, $b) {
@if ($b != 0) {
@return gcd($b, $a % $b);
} @else {
@return abs($a);
}
}

// Handles decimal exponents by trying to convert them into a fraction and then
// use a nthRoot-algorithm for parts of the calculation
@function pow($base, $exponent, $prec: 12) {
@if (floor($exponent) != $exponent) {
$prec2 : pow(10, $prec);
$exponent: round($exponent * $prec2);
$denominator: gcd($exponent, $prec2);
@return nthRoot(pow($base, $exponent / $denominator), $prec2 / $denominator, $prec);
}

$value: $base;
@if $exponent > 1 {
@for $i from 2 through $exponent {
$value: $value * $base;
}
} @else if $exponent < 1 {
@for $i from 0 through -$exponent {
$value: $value / $base;
}
}

@return $value;
}

// From: http://rosettacode.org/wiki/Nth_root#JavaScript
@function nthRoot($num, $n: 2, $prec: 12) {
$x: 1;

@for $i from 0 through $prec {
$x: 1 / $n * (($n - 1) * $x + ($num / pow($x, $n - 1)));
}

@return $x;
}
9 changes: 9 additions & 0 deletions src/global_styling/index.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
// Core

// Functions need to be first, since we use them in our variables and mixin definitions
@import 'functions/index';

// Variables come next, and are used in some mixins
@import 'variables/index';

// Mixins provide generic code expansion through helpers
@import 'mixins/index';

// The reset file makes use of variables and mixins
@import 'reset/index';
30 changes: 1 addition & 29 deletions src/global_styling/variables/_colors.scss
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
// Mixes a provided color with white.
@function tint($color, $percent) {
@return mix(#fff, $color, $percent);
}

// Mixes a provided color with black.
@function shade($color, $percent) {
@return mix(#000, $color, $percent);
}

// For theming. Checks the text color and tells us whether it's light or dark.
// Based on that we either tint or shade.
@function tintOrShade($color, $tint, $shade) {
@if (lightness($euiTextColor) > 50) {
@return shade($color, $shade);
} @else {
@return tint($color, $tint);
}
}

@function shadeOrTint($color, $shade, $tint) {
@if (lightness($euiTextColor) < 50) {
@return shade($color, $shade);
} @else {
@return tint($color, $tint);
}
}

// Core

$euiColorPrimary: #0079a5 !default;
Expand All @@ -37,7 +9,7 @@ $euiColorGhost: #FFF !default;
// Status
$euiColorSuccess: $euiColorSecondary !default;
$euiColorDanger: #A30000 !default;
$euiColorWarning: #CF3800 !default;
$euiColorWarning: #E5830E !default;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reverts back to our "yellow" color for warnings so everything looks ok again. It becomes darker through use of the functions as we need it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


// Grays
$euiColorEmptyShade: #FFF !default;
Expand Down
2 changes: 1 addition & 1 deletion src/themes/eui/eui_colors_dark.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ $euiColorDarkestShade: #F5F5F5;
$euiColorFullShade: #FFF;
$euiColorSlightHue: #494E51;
$euiColorPrimary: #4da1c0;
$euiColorWarning: #e45c29;
$euiColorWarning: #c06c4c;
$euiColorDanger: #bf4d4d;
$euiTextColor: #DDD;

Expand Down