[docs] More explicit breakpoint documentation in sx
#26140
Merged
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
eps1lon
commented
May 5, 2021
| The `unstable_styleFunctionSx` utility adds the support for the `sx` to your own components. Normally you would use the `Box` components from `@material-ui/core` at the root of your component tree. If you would like to use the system independently from Material-UI, this utility will give you the same capabilities, while having a smaller bundle size. | ||
| The `unstable_styleFunctionSx` utility adds the support for the [`sx` prop](/system/basics/#the-sx-prop) to your own components. | ||
| Normally you would use the `Box` component from `@material-ui/core` at the root of your component tree. | ||
| If you would like to use the system independently from Material-UI, the `unstable_styleFunctionSx` utility will give you the same capabilities, while having a smaller bundle size. |
There was a problem hiding this comment.
The "this" refernce was more than one sentence away. I noticed that I had to stop reading to understand what this is referring to (I wasn't sure if "this" referred to Box or unstable_styleFunctionSx even though unstable_styleFunctionSx is implied by "this utility".
There was a problem hiding this comment.
Looks good.
For the up behavior, we had #25846 to ask for a way to configure a down one
Which is relevant for |
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.
Helps review
sxdoes whenever it is mentionedThis helps discovery if algolia decides to display a mention of
sxas the first resultthismention (https://developers.google.com/tech-writing/one/words#this_and_that)thiscan work if the reference is obvious. That's not always obvious though and may even change over time if sentences move farther apart.sx={{ lg: {} }}matchesbreakpoints comparison was mentioned in the paragraph earlier in a code comment so easy to miss if you already know
sxbut not how breakpoints work.See my struggle in [Hidden] Remove component #26135 (comment)