Set default theme #187
Merged
Set default theme #187
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merged
emplums
reviewed
Aug 6, 2018
| @@ -31,4 +25,7 @@ CaretBox.defaultProps = { | |||
| position: 'relative' | |||
| } | |||
|
|
|||
| export default withSystemProps(CaretBox, ['color']) | |||
| // we can set this because it "inherits" all of Box's system props | |||
| CaretBox.systemComponent = true | |||
There was a problem hiding this comment.
Can you explain why this needs to be set? I missed this addition!
There was a problem hiding this comment.
Because CaretBox renders a Box and forwards most of its props, it can safely be considered a system component even though we don't call withSystemProps() on it explicitly. In fact, if we do, it causes that weird double-render bug that I mentioned above.
This was referenced Aug 6, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This simplifies our system-props helpers by removing all but
withSystemProps(), updating that to use system-components'system(), and adding awithDefaultTheme()function that sets the component'sdefaultProps.themeto our internal theme object so that there's no need for a ThemeProvider to get primer styles.One problem that I ran into here was that a couple of our components were "extending" system components (CircleOcticon → FlexContainer, CaretBox → Box), which (because of how system-components does things) was actually calling the underlying render function twice with different props. I've attempted to catch cases of this by looking for instances of either components that were directly created with
system(), which getsystemComponent = true, or detecting whetherdefaultProps.blacklistis an array, which happens when we spread another system component's defaultProps into ours.I've also added (and marked as pending for un-migrated components) a test to each component's suite that asserts
Component.systemComponent === true. This will need to be set manually for components that aren't explicitly created with eithersystem()orwithSystemProps()because the former is what sets that flag.Fixes #186.