Skip to content

Colour contrast test #194

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

Draft
frederickobrien wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Colour contrast test #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b6867b
Basic test
frederickobrien Dec 9, 2024
df275e6
Adjust test
frederickobrien Dec 10, 2024
886b5d2
Update contrast.test.ts
frederickobrien Jan 12, 2025
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
7 changes: 7 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"@types/eslint": "^8.56.12",
"@typescript-eslint/eslint-plugin": "^7.18.0",
"@typescript-eslint/parser": "^7.18.0",
"color-contrast-checker": "^2.1.0",
"eslint": "^8.57.1",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-storybook": "^0.11.1",
Expand Down
46 changes: 46 additions & 0 deletions src/utils/contrast.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { expect, test } from 'vitest';
import ColorContrastChecker from 'color-contrast-checker';
import type { ReviewMetadata } from '$lib/types/reviews';

const reviews = await fetch(`https://api.audioxide.com/reviews.json`);
const data: {
metadata: ReviewMetadata;
}[] = await reviews.json();

const ccc = new ColorContrastChecker();

test('Colour contrast on review pages', () => {
const passingReviews: string[] = [];
const failingReviews: string[] = [];

data.forEach(({ metadata }) => {
const primaryColor = metadata.colours[0];
const secondaryColor = metadata.colours[1];
const tertiaryColor = metadata.colours[2];
const summaryTextColour = metadata.colours[3] ? metadata.colours[3] : primaryColor;

const primaryContrast = ccc.isLevelAA(primaryColor, '#ffffff', 40);
const secondaryContrast = ccc.isLevelAA(secondaryColor, primaryColor);
const tertiaryContrast = ccc.isLevelAA(tertiaryColor, primaryColor);
const summaryContrast = ccc.isLevelAA(summaryTextColour, '#ffffff', 18);

const allTestsPass =
primaryContrast && secondaryContrast && tertiaryContrast && summaryContrast;

if (!allTestsPass) {
failingReviews.push(metadata.album);
} else {
passingReviews.push(metadata.album);
}

expect(allTestsPass).toBe(true);
});

console.log('Passing reviews: ' + passingReviews.length);
console.log('Failing reviews: ' + failingReviews.length);

console.warn('Reviews failing WCAG AA contrast requirements:');
failingReviews.forEach((album) => {
console.warn(album);
});
});