Skip to content

feat(CSS): add base background-color and color styles on body

Scott de Jonge requested to merge sdejonge-base-styles into main

What does this MR do?

Currently the background-color and color properties are set on the <body> element viz Bootstrap's reboot.scss:

body {
  margin: 0; // 1
  font-family: $font-family-base;
  @include font-size($font-size-base);
  font-weight: $font-weight-base;
  line-height: $line-height-base;
  color: $body-color;
  text-align: left; // 3
  background-color: $body-bg; // 2
}

This MR introduces a seperate stylesheet to use design token CSS custom properties on <body>.

body {
  background-color: var(--gl-background-color-default);
  color: var(--gl-text-color-default);
}
Before After
#28272d #3a383f

This allows us to toggle .gl-dark class on :root to see dark mode variants while viewing a Storybook story in isolation (see screen recording below).

This also ensures components which inherit text color value from the DOM i.e. GlAccordian are inheriting the expected value text.color.default.

This will also mean consumers like GitLab will have these CSS custom properties on the <body> moving us closer to only using the gl-dark class to toggle dark mode.

Screenshots or screen recordings

CleanShot_2024-08-14_at_11.54.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