Skip to content

feat(DesignTokens): add color contrast score and level to stories

Scott de Jonge requested to merge design-token-stories-contrast into main

What does this MR do?

gitlab-org/gitlab-services/design.gitlab.com!3619 (merged) aims to replace custom color palette components in design.gitlab.com with Storybook story embeds from GitLab UI. A trade off is that current visualisations on https://design.gitlab.com/product-foundations/color present color contrast scores and WCAG F/AA/AA+/AAA levels for use with white/dark text. This MR aims to bring that same functionality to GitLab UI Storybook stories, displayed static instead to ensure capture by image regression testing.

Extend common_story_options.js methods and template to provide color contrast score and level within Storybook stories.

Screenshots or screen recordings

localhost_9001__path__story_tokens-color-base-light--gray_globals_backgrounds.grid__false_backgrounds.value_transparent

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • 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 (see integration merge requests above).
  • 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 Scott de Jonge

Merge request reports