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

Avatar, BranchName, Details, Heading, and ProgressBar no longer accept styled-system props. #1643

Merged
merged 1 commit into from
Nov 30, 2021

Conversation

jfuchs
Copy link
Contributor

@jfuchs jfuchs commented Nov 22, 2021

I went to clean up some docs and noticed I missed a few in the first pass.

See https://github.com/github/primer/issues/296.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@jfuchs jfuchs requested review from colebemis and a team November 22, 2021 23:45
@changeset-bot
Copy link

changeset-bot bot commented Nov 22, 2021

🦋 Changeset detected

Latest commit: 60a9a76

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

This PR includes changesets to release 1 package
Name Type
@primer/components Major

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 22, 2021

size-limit report 📦

Path Size
dist/browser.esm.js 57.34 KB (-0.07% 🔽)
dist/browser.umd.js 57.74 KB (-0.08% 🔽)

@@ -6,7 +6,7 @@ import {PropsList, COMMON, LAYOUT, BORDER, TYPOGRAPHY, FLEX, POSITION, GRID} fro

<Note variant="warning">

System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
System props are deprecated in all components except [Box](/Box) and [Text](/Text). Please use the [`sx` prop](/overriding-styles) instead.
Copy link
Collaborator

Choose a reason for hiding this comment

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

TIL. Why are these two components the exceptions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As I understand it, the thought is that these two components are the basic building blocks of styling — whereas other components should be opinionated about their styling and overriding their styles shouldn't be as dominant a part of their API.

I lean toward this approach but I don't think it would be the end of the world if we went with sx everywhere.

cc @colebemis who I think is on the fence about it.

@jfuchs jfuchs merged commit 3938550 into main Nov 30, 2021
@jfuchs jfuchs deleted the jfuchs/oh-no-theres-more branch November 30, 2021 18:06
@primer-css primer-css mentioned this pull request Nov 30, 2021
pksjce pushed a commit that referenced this pull request Dec 20, 2021
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.

None yet

3 participants