-
Notifications
You must be signed in to change notification settings - Fork 526
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
Conversation
🦋 Changeset detectedLatest commit: 60a9a76 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
size-limit report 📦
|
3cbe0b3
to
dcf5b03
Compare
@@ -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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
…t styled-system props.
7ce4896
to
60a9a76
Compare
…t styled-system props. (#1643)
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
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.