Skip to content

feat(DesignTokens): add container background and border design tokens

Scott de Jongerequested to merge
sdejonge-surface-tokens into main

What does this MR do?

Objective

Outcomes

  1. We need a color.neutral.0/color.neutral.800 background design token to be used for dropdown/drawer etc. backgrounds
    1. This differs from the background.color.default which is used for the background on <body> and is color.neutral.0/color.neutral.950
    2. This will also be applied to the "headers" of "container" style used in Project files overview, comment threads etc.
    3. The "content" of "container" will use background.color.subtle, possibly also abstracted to a contextual token for consistency
  2. We need a border.color.default/color.neutral.950 (or body background) border color for the dark mode treatment of "container" borders
  3. We need to updated background.color.strong to color.neutral.700 in dark mode reverted to only be additive changes

Risks

  1. Changes to background.color.default inherit a breaking change and require a migration to updated CSS custom property (var(--gl-color-background-default)) and utility class (gl-bg-default)

Subjective

  1. background.color.default should be the <body> background:
    1. It aligns with existing "default" naming and reasoning
    2. It "just works" for fixed/absolute/sticky elements displaying over other contents
  2. I really don't want to incur another migration or pause design token rollout for a name change
  3. I disagree that color.neutral.0/color.neutral.800 (drawer, dropdowns) is more common than color.neutral.0/color.neutral.950 (fixed/absolute/sticky elements) in usage
    1. It is in GitLab UI
    2. It isn't in GitLab
    3. Most if not all of our migrations are going to be:
      1. background-color: $white to background-color: var(--gl-color-background-default)
      2. gl-bg-white to gl-bg-default
  4. I don't like the "container" name

Screenshots or screen recordings

CleanShot_2024-08-21_at_15.00.55

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