Skip to content

Draft: Heading update full test - DO NOT MERGE

Dan MH — OOO requested to merge DO-NOT-MERGE-typescale-northish-star-danmh into main

What does this MR do?

Update: Proposal documented in 👉👉👉 #2137 👈👈👈

We are updating the heading styles used across GitLab to improve visual hierarchy, balance, and consistency. These updates should make GitLab easier to use for our users.

Integration

  • This MR is best viewed with the following integration branch gitlab!127244
  • This MR is to figure out the desired end state. Implementation will be broken out into much smaller iterative MRs.

Goals and constraints

This proposal tries to:

  • Make it easy to apply the correct heading styles.
  • Add friction to diverge from the system defaults, but not prevent it.
  • Create the ability to make system-wide changes based on context.
  • Reduce effort to migrate to tokenised typography.

... within the following technical considerations[1]:

  • Don't apply styles to root elements.
  • Each style should be added through a class.
  • Don't introduce breaking changes.
  • Allow for roll-out in many small MRs.

... by doing the following:

  • Aliasing specific design decisions as unique variables to communicate intention, allow systematic updates, and promote consistency. For example, $gl-mb-heading and $gl-font-weight-heading.
  • Grouping multiple design decisions together into a mixin which matches specific variations to conditions. See @mixin gl-heading.
  • Classes have a specific scope, and should only be used that context for example, gl-heading-1 or gl-card-title[2].

This proposal weakly holds the following opinions:

  • How the mixins and functions are generated and applied.
  • If the component specific scope should be controlled by creating classes to add to the markup, or included in stylesheets.
  • Names for everything.

[1] Read more about these in some earlier conversations #2246 (comment 1430871587) [2] My assumption is that to have an effective systematic approach there should be no 'base' classes applied in GitLab. Only classes that communicate the reason for the specific value rather than the value itself. Doing so allows us to maintain and update context specific choices in a predictable and systematic way. These so-called 'semantic classes' would be aliases of other defined variables.

Related:

Screenshots or screen recordings

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 Dan MH — OOO

Merge request reports