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

Improve duotone support in River #894

Merged
merged 3 commits into from
Jan 17, 2025
Merged

Conversation

rezrah
Copy link
Collaborator

@rezrah rezrah commented Jan 16, 2025

Summary

Closes https://github.com/github/primer/issues/3654

A dutotone river example already exists in Storybook, but it's too small and used <strong> element for highlighting, which is now deprecated for accessibility reasons.

This PR replaces those examples with <b> elements, which are more semantically correct and makes a few other adjustments to increase visibility of this feature.

List of notable changes:

  • Added <b> tag support to existing duotone river
  • Updated font-weight to be semibold, matching all other emphasised text instances
  • Increased sizes in our examples to 300.
    I haven't made this part of the API because the size is likely to change depending on usage.
  • Added a new dedicated story for Duotone
  • Updated RiverStoryScroll examples to use dutotone text, matching the original request
  • Added a duotone example to documentation page
  • Replaced remote placeholders in River page with a local fixture, as they are currently failing

What should reviewers focus on?

  • Happy decreasing font-weight to semibold from browser default of bold (700)?
  • Has duotone been applied per design specs

Steps to test:

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
  • UI Changes contain new visual snapshots (generated by adding update snapshots label to the PR)
  • 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

Screenshots:

Please try to provide before and after screenshots or videos

Before After

Screenshot 2025-01-16 at 12 40 12

Screenshot 2025-01-16 at 12 39 52

Copy link

changeset-bot bot commented Jan 16, 2025

🦋 Changeset detected

Latest commit: d2c0684

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@primer/react-brand Patch
@primer/brand-primitives Patch
@primer/brand-e2e Patch
@primer/brand-fonts Patch
@primer/brand-config Patch
@primer/brand-storybook Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Jan 16, 2025

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Jan 16, 2025

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

Copy link

@simmonsjenna simmonsjenna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@rezrah rezrah merged commit aecc8d8 into main Jan 17, 2025
17 checks passed
@rezrah rezrah deleted the rezrah/duotone-river-headings branch January 17, 2025 13:40
@primer-css primer-css mentioned this pull request Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants