Skip to content

feat(CSS): add type.scss to set heading text color

Scott de Jonge requested to merge sdejonge-heading-color into main

What does this MR do?

Set heading text color to text.color.heading design tokens using Tailwind utility class.

Similiar approach as to setting background-color and color properties on <body> overriding Bootstrap reboot styles in !4500 (merged).

Additive change to leverage CSS cascade to set value.

Opted to not remove $headings-color Bootstrap SCSS variable as part of this change as it impacts other variables like $popover-header-color etc.

To validate:

  1. navigate to a Storybook story that uses <hx> content like http://localhost:9001/?path=/story/base-card--default
  2. inspect heading element
  3. confirm color is inheriting the --gl-text-color-heading design token CSS custom property

Screenshots or screen recordings

Light Dark
localhost_9001__path__story_base-card--default localhost_9001__path__story_base-card--default__1_

Integration merge requests

diff --git a/app/assets/stylesheets/_application_base.scss b/app/assets/stylesheets/_application_base.scss
index 1b99a27b12cc..cb2637254f58 100644
--- a/app/assets/stylesheets/_application_base.scss
+++ b/app/assets/stylesheets/_application_base.scss
@@ -29,3 +29,9 @@
 
 // print styles
 @import 'print';
+
+h1, h2, h3, h4, h5, h6,
+.h1, .h2, .h3, .h4, .h5, .h6 {
+  @apply gl-text-heading;
+}
+
Before After
CleanShot_2024-10-31_at_10.59.28 CleanShot_2024-10-31_at_10.58.54

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