Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Presentational color tokens for icon patterns #516

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

langermank
Copy link
Contributor

@langermank langermank commented Dec 19, 2023

Summary

Part of https://github.com/github/primer/issues/2097

While auditing the existing color tokens and renaming to align with the convention, I noticed a lot of duplication between component tokens primarily used for icon fg/bg color. This feels like a good opportunity to add presentation tokens to ensure consistency across icon color combinations.

An alternative solution here could be to add a new component to handle these common icon scenarios, and place these in the icon pattern. However, that leaves out patterns like Label that use fg color similarly to icons.

Feel free to check out this audit showing the minor differences that are flattened with this PR.

List of notable changes:

  • Removed component color tokens for Card, EyebrowBanner, Label, Pillar, and Testimonial
  • Added generic fgColor and bgColor presentation colors

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Copy link

changeset-bot bot commented Dec 19, 2023

⚠️ No Changeset found

Latest commit: 7b121ff

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 19, 2023

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Dec 19, 2023

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

artifacts section of workflow run

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant