Skip to content

fix(utils): Change color util to use relative luminance

Sascha Eggenberger requested to merge change-color-util into main

What does this MR do?

Changes color function to check for relative luminance. Until now we just calculated the sum of the RGB value and checked if it is higher than a value of 500 which seems not a very safe way in doing so. This MR changes the color function to use the relative luminance calculation from WCAG.

Before After
before after

Test URL: http://localhost:9001/?path=/story/base-label--default&args=backgroundColor:!hex(eee600)

Note it doesn't always lead to a 3:1 contrast ratio. As this method uses relative luminance it should fully comply with APCA, which is set to be used for WCAG 3.0.

Related to Change color function to check for relative lum... (gitlab!118622 - merged)

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Sascha Eggenberger

Merge request reports