Add documentation for including styles that use the value of a prop #23
Conversation
This file contains hidden or 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
| function MyComponent({ bold, padding, styles }) { | ||
| const { | ||
| backgroundImageUrl, | ||
| } = this.props; |
There was a problem hiding this comment.
Since this is a stateless functional component, this.props is not right. This should be destructured in the method signature along with the rest of the props.
| @@ -317,6 +317,35 @@ export default withStyles(({ color, unit }) => ({ | |||
|
|
|||
| `className` and `style` props must not be used on the same elements as `css()`. | |||
|
|
|||
| ### Using the value of a prop / high cardinality | |||
|
|
|||
| To include styles that use the value of a prop (or any other styles that have a high cardinality and shouldn't be in a themed stylesheet), you can use inline styles in conjunction with `withstyles()`. | |||
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.
The current documentation doesn't clearly call out the use of inline styles in the cases where the value comes from a prop, which can lead to implementations that attempt to use the "style" prop along with "withStyles" and violate the style guide.
The example provided is consistent with the best practices detailed in the style guide: https://github.com/airbnb/javascript/tree/master/css-in-javascript#inline
To: @lencioni