-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #40773 from nextcloud/fix/contrast-maxcontrast-vs-…
…hover fix(theming): Ensure all text colors have enough contrast for accessibility
- Loading branch information
Showing
12 changed files
with
235 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| // eslint-disable-next-line import/no-webpack-loader-syntax, import/no-unresolved | ||
| import style from '!raw-loader!../css/default.css' | ||
|
|
||
| const testCases = { | ||
| 'Main text': { | ||
| foregroundColors: [ | ||
| 'color-main-text', | ||
| // 'color-text-light', deprecated | ||
| // 'color-text-lighter', deprecated | ||
| 'color-text-maxcontrast', | ||
| 'color-text-maxcontrast-default', | ||
| ], | ||
| backgroundColors: [ | ||
| 'color-background-main', | ||
| 'color-background-hover', | ||
| 'color-background-dark', | ||
| // 'color-background-darker', this should only be used for elements not for text | ||
| ], | ||
| }, | ||
| Primary: { | ||
| foregroundColors: [ | ||
| 'color-primary-text', | ||
| ], | ||
| backgroundColors: [ | ||
| // 'color-primary-default', this should only be used for elements not for text! | ||
| // 'color-primary-hover', this should only be used for elements and not for text! | ||
| 'color-primary', | ||
| ], | ||
| }, | ||
| 'Primary light': { | ||
| foregroundColors: [ | ||
| 'color-primary-light-text', | ||
| ], | ||
| backgroundColors: [ | ||
| 'color-primary-light', | ||
| 'color-primary-light-hover', | ||
| ], | ||
| }, | ||
| 'Primary element': { | ||
| foregroundColors: [ | ||
| 'color-primary-element-text', | ||
| 'color-primary-element-text-dark', | ||
| ], | ||
| backgroundColors: [ | ||
| 'color-primary-element', | ||
| 'color-primary-element-hover', | ||
| ], | ||
| }, | ||
| 'Primary element light': { | ||
| foregroundColors: [ | ||
| 'color-primary-element-light-text', | ||
| ], | ||
| backgroundColors: [ | ||
| 'color-primary-element-light', | ||
| 'color-primary-element-light-hover', | ||
| ], | ||
| }, | ||
| 'Servity information texts': { | ||
| foregroundColors: [ | ||
| 'color-error-text', | ||
| 'color-warning-text', | ||
| 'color-success-text', | ||
| 'color-info-text', | ||
| ], | ||
| backgroundColors: [ | ||
| 'color-background-main', | ||
| 'color-background-hover', | ||
| ], | ||
| }, | ||
| } | ||
|
|
||
| /** | ||
| * Create a wrapper element with color and background set | ||
| * | ||
| * @param foreground The foreground color (css variable without leading --) | ||
| * @param background The background color | ||
| */ | ||
| function createTestCase(foreground: string, background: string) { | ||
| const wrapper = document.createElement('div') | ||
| wrapper.innerText = `${foreground} ${background}` | ||
| wrapper.style.color = `var(--${foreground})` | ||
| wrapper.style.backgroundColor = `var(--${background})` | ||
| wrapper.style.padding = '4px' | ||
| wrapper.setAttribute('data-cy-testcase', '') | ||
| return wrapper | ||
| } | ||
|
|
||
| describe('Accessibility of Nextcloud theming', () => { | ||
| before(() => { | ||
| cy.injectAxe() | ||
|
|
||
| const el = document.createElement('style') | ||
| el.innerText = style | ||
| document.head.appendChild(el) | ||
| }) | ||
|
|
||
| beforeEach(() => { | ||
| cy.document().then(doc => { | ||
| const root = doc.querySelector('[data-cy-root]') | ||
| if (root === null) { | ||
| throw new Error('No test root found') | ||
| } | ||
| for (const child of root.children) { | ||
| root.removeChild(child) | ||
| } | ||
| }) | ||
| }) | ||
|
|
||
| for (const [name, { backgroundColors, foregroundColors }] of Object.entries(testCases)) { | ||
| context(`Accessibility of CSS color variables for ${name}`, () => { | ||
| for (const foreground of foregroundColors) { | ||
| for (const background of backgroundColors) { | ||
| it(`color contrast of ${foreground} on ${background}`, () => { | ||
| const element = createTestCase(foreground, background) | ||
| cy.document().then(doc => { | ||
| const root = doc.querySelector('[data-cy-root]') | ||
| // eslint-disable-next-line no-unused-expressions | ||
| expect(root).not.to.be.undefined | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| root!.appendChild(element) | ||
| cy.checkA11y('[data-cy-testcase]') | ||
| }) | ||
| }) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.