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.

Sign up for GitHub

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

Jump to bottom

fix(color-contrast-enhanced): avoid duplicates between color-contrast and color-contrast-enhanced #3714

Merged
merged 4 commits into from
Oct 13, 2022
Merged

fix(color-contrast-enhanced): avoid duplicates between color-contrast and color-contrast-enhanced #3714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebdff41
fix(color-contrast-enhanced): only report violations for contrasts th…
straker Oct 11, 2022
e6d94c7
report incomplete
straker Oct 12, 2022
5a5ef02
Update lib/checks/color/color-contrast-evaluate.js
straker Oct 13, 2022
cf6bdfe
changes
straker Oct 13, 2022
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
2 changes: 1 addition & 1 deletion doc/rule-descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
| [blink](https://dequeuniversity.com/rules/axe/4.4/blink?application=RuleDescription) | Ensures <blink> elements are not used | Serious | cat.time-and-media, wcag2a, wcag222, section508, section508.22.j | failure | |
| [button-name](https://dequeuniversity.com/rules/axe/4.4/button-name?application=RuleDescription) | Ensures buttons have discernible text | Critical | cat.name-role-value, wcag2a, wcag412, section508, section508.22.a, ACT | failure, needs review | [97a4e1](https://act-rules.github.io/rules/97a4e1), [m6b1q3](https://act-rules.github.io/rules/m6b1q3) |
| [bypass](https://dequeuniversity.com/rules/axe/4.4/bypass?application=RuleDescription) | Ensures each page has at least one mechanism for a user to bypass navigation and jump straight to the content | Serious | cat.keyboard, wcag2a, wcag241, section508, section508.22.o | needs review | [cf77f2](https://act-rules.github.io/rules/cf77f2), [047fe0](https://act-rules.github.io/rules/047fe0), [b40fd1](https://act-rules.github.io/rules/b40fd1), [3e12e1](https://act-rules.github.io/rules/3e12e1), [ye5d6e](https://act-rules.github.io/rules/ye5d6e) |
| [color-contrast](https://dequeuniversity.com/rules/axe/4.4/color-contrast?application=RuleDescription) | Ensures the contrast between foreground and background colors meets WCAG 2 AA contrast ratio thresholds | Serious | cat.color, wcag2aa, wcag143, ACT | failure, needs review | [afw4f7](https://act-rules.github.io/rules/afw4f7) |
| [color-contrast](https://dequeuniversity.com/rules/axe/4.4/color-contrast?application=RuleDescription) | Ensures the contrast between foreground and background colors meets WCAG 2 AA contrast ratio thresholds | Serious | cat.color, wcag2aa, wcag143, ACT | failure, needs review | [afw4f7](https://act-rules.github.io/rules/afw4f7), [09o5cg](https://act-rules.github.io/rules/09o5cg) |
| [definition-list](https://dequeuniversity.com/rules/axe/4.4/definition-list?application=RuleDescription) | Ensures <dl> elements are structured correctly | Serious | cat.structure, wcag2a, wcag131 | failure | |
| [dlitem](https://dequeuniversity.com/rules/axe/4.4/dlitem?application=RuleDescription) | Ensures <dt> and <dd> elements are contained by a <dl> | Serious | cat.structure, wcag2a, wcag131 | failure | |
| [document-title](https://dequeuniversity.com/rules/axe/4.4/document-title?application=RuleDescription) | Ensures each HTML document contains a non-empty <title> element | Serious | cat.text-alternatives, wcag2a, wcag242, ACT | failure | [2779a5](https://act-rules.github.io/rules/2779a5) |
Expand Down
6 changes: 4 additions & 2 deletions lib/checks/color/color-contrast-enhanced.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@
"largeTextPt": 18,
"contrastRatio": {
"normal": {
"expected": 7
"expected": 7,
"minThreshold": 4.5
},
"large": {
"expected": 4.5
"expected": 4.5,
"minThreshold": 3
}
},
"pseudoSizeThreshold": 0.25,
Expand Down
4 changes: 2 additions & 2 deletions lib/checks/color/color-contrast-evaluate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ export default function colorContrastEvaluate(node, options, virtualNode) {

// ratio is outside range
if (
(typeof minThreshold === 'number' && contrast < minThreshold) ||
(typeof maxThreshold === 'number' && contrast > maxThreshold)
(typeof minThreshold === 'number' && (typeof contrast !== 'number' || contrast < minThreshold)) ||
(typeof maxThreshold === 'number' && (typeof contrast !== 'number' || contrast > maxThreshold))
) {
this.data({ contrastRatio: contrast });
return true;
Expand Down
22 changes: 22 additions & 0 deletions lib/commons/color/get-background-color.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import flattenColors from './flatten-colors';
import flattenShadowColors from './flatten-shadow-colors';
import getTextShadowColors from './get-text-shadow-colors';
import visuallyContains from '../dom/visually-contains';
import { getNodeFromTree } from '../../core/utils';

/**
* Returns background color for element
Expand All @@ -25,6 +26,27 @@ export default function getBackgroundColor(
bgElms = [],
shadowOutlineEmMax = 0.1
) {
const vNode = getNodeFromTree(elm);
const bgColorCache = vNode._cache.getBackgroundColor;

if (bgColorCache) {
bgElms.push(...bgColorCache.bgElms);
incompleteData.set('bgColor', bgColorCache.incompleteData);
return bgColorCache.bgColor;
}

const bgColor = _getBackgroundColor(elm, bgElms, shadowOutlineEmMax);

vNode._cache.getBackgroundColor = {
bgColor,
bgElms,
incompleteData: incompleteData.get('bgColor')
};

return bgColor;
}

function _getBackgroundColor(elm, bgElms, shadowOutlineEmMax) {
let bgColors = getTextShadowColors(elm, { minRatio: shadowOutlineEmMax });
if (bgColors.length) {
bgColors = [{ color: bgColors.reduce(flattenShadowColors) }];
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/color-contrast.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"matches": "color-contrast-matches",
"excludeHidden": false,
"tags": ["cat.color", "wcag2aa", "wcag143", "ACT"],
"actIds": ["afw4f7"],
"actIds": ["afw4f7", "09o5cg"],
"metadata": {
"description": "Ensures the contrast between foreground and background colors meets WCAG 2 AA contrast ratio thresholds",
"help": "Elements must have sufficient color contrast"
Expand Down
2 changes: 1 addition & 1 deletion test/act-rules/text-contrast-enhanced-09o5cg.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
require('./act-runner.js')({
id: '09o5cg',
title: 'Text has enhanced contrast',
axeRules: ['color-contrast-enhanced']
axeRules: ['color-contrast', 'color-contrast-enhanced']
});
76 changes: 76 additions & 0 deletions test/checks/color/color-contrast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,25 @@ describe('color-contrast', function () {
assert.deepEqual(checkContext._relatedNodes, []);
});

it('should not report incomplete when options.contrastRatio.normal.minThreshold is set', function () {
var params = checkSetup(
`
<p id="target" style="color: #666; background: linear-gradient(to right, #FFF, #0FF); width: 300px">
Some text in English
</p>`,
{
contrastRatio: {
normal: {
minThreshold: 3
}
}
}
);

assert.isTrue(contrastEvaluate.apply(checkContext, params));
assert.isUndefined(checkContext._data.messageKey);
});

it('should support options.contrastRatio.normal.maxThreshold', function () {
var params = checkSetup(
'<div style="color: #999; background-color: white; font-size: 14pt; font-weight: 100" id="target">' +
Expand All @@ -740,6 +759,25 @@ describe('color-contrast', function () {
assert.deepEqual(checkContext._relatedNodes, []);
});

it('should not report incomplete when options.contrastRatio.normal.maxThreshold is set', function () {
var params = checkSetup(
`
<p id="target" style="color: #666; background: linear-gradient(to right, #FFF, #0FF); width: 300px">
Some text in English
</p>`,
{
contrastRatio: {
normal: {
maxThreshold: 2
}
}
}
);

assert.isTrue(contrastEvaluate.apply(checkContext, params));
assert.isUndefined(checkContext._data.messageKey);
});

it('should support options.contrastRatio.large.expected', function () {
var params = checkSetup(
'<div style="color: #ccc; background-color: white; font-size: 18pt; font-weight: 100" id="target">' +
Expand Down Expand Up @@ -774,6 +812,25 @@ describe('color-contrast', function () {
assert.deepEqual(checkContext._relatedNodes, []);
});

it('should not report incomplete when options.contrastRatio.large.minThreshold is set', function () {
var params = checkSetup(
`
<p id="target" style="color: #666; background: linear-gradient(to right, #FFF, #0FF); width: 300px; font-size: 18pt;">
Some text in English
</p>`,
{
contrastRatio: {
large: {
minThreshold: 2
}
}
}
);

assert.isTrue(contrastEvaluate.apply(checkContext, params));
assert.isUndefined(checkContext._data.messageKey);
});

it('should support options.contrastRatio.large.maxThreshold', function () {
var params = checkSetup(
'<div style="color: #ccc; background-color: white; font-size: 18pt; font-weight: 100" id="target">' +
Expand All @@ -791,6 +848,25 @@ describe('color-contrast', function () {
assert.deepEqual(checkContext._relatedNodes, []);
});

it('should not report incomplete when options.contrastRatio.large.maxThreshold is set', function () {
var params = checkSetup(
`
<p id="target" style="color: #666; background: linear-gradient(to right, #FFF, #0FF); width: 300px; font-size: 18pt;">
Some text in English
</p>`,
{
contrastRatio: {
large: {
maxThreshold: 2
}
}
}
);

assert.isTrue(contrastEvaluate.apply(checkContext, params));
assert.isUndefined(checkContext._data.messageKey);
});

it('should ignore pseudo element with options.ignorePseudo', function () {
var params = checkSetup(
'<style>.foo { position: relative; } .foo:after { content: ""; position: absolute; width: 100%; height: 100%; background: red; }</style>' +
Expand Down