Skip to content

Tailwind add text color design tokens to the preset

Scott de Jonge requested to merge tailwind-config-compiled-tokens into main

What does this MR do?

Update tailwind config to consume compiled token JSON and add text color design tokens to tailwind preset.

!3908 (merged) creates text.primary, text.secondary, and text.tertiary design tokens as part of the design token pilot &12381.

These design tokens are aliases for existing gray primitive/base color design tokens
{
  "text": {
    "primary": {
      "$value": "{gray.900}",
      "$type": "color",
      "themeable": true
    },
    "secondary": {
      "$value": "{gray.500}",
      "$type": "color",
      "themeable": true
    },
    "tertiary": {
      "$value": "{gray.400}",
      "$type": "color",
      "themeable": true
    }
  }
}

In order to use Tailwind to create utility classes from these design tokens they require the compiled values for each token:

Token Equals light dark
text.primary {gray.900} #333238 #ececef
text.secondary {gray.500} #737278 #89888d
text.tertiary {gray.400} #89888d #737278

Using ./dist/tokens/json/tokens.json exposed the compiled hex values for each design token, as well as the path which can be used to construct CSS custom property name for var(--design-token-name, #000) (or var(--design-token-name, #000) if prefix not false).

Screenshots or screen recordings

CleanShot_2024-03-01_at_16.37.28_2x

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