[docs] Improve system properties page #23961
Conversation
There was a problem hiding this comment.
A couple of thoughts:
- I'm slightly leaning toward legend after, but happy to follow @mbrookes direction on this
- It would be interesting to add a reminder, just before the table that it only covers the custom properties, all the CSS properties are supported too.
| @@ -1,19 +1,30 @@ | |||
| # Properties | |||
|
|
|||
| <p class="description">This page lists all of the custom system properties, how are they linked with the theme, and which CSS properties they compute.</p> | |||
| <p class="description">This page lists all of the custom system properties, how are they linked with the theme, and which CSS properties they compute. All other regular CSS properties and selectors are supported too.</p> | |||
There was a problem hiding this comment.
Forgive me if I'm missing something obvious (not a first!), but in what sense are all are CSS selectors supported?
There was a problem hiding this comment.
You can specify any valid CSS as javascript object, which includes use of pseudo selectors, like :hover, or class selectors, like & .MuiButton-root: {} etc
There was a problem hiding this comment.
Yes, I was thinking that "all" might be a bit broad, but I guess trying to caveat it would make it overly complicated.
Since the table is quite long, I think it's better to present the explanation first (with the sample as a reference), rather than hoping that the reader makes it to the bottom for an explanation. |
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
zannager
added
docs
This PR removes the group column from the properties tables, moving the links to the next column (System style function), where the links where possible are linking to the exact style function from that group.
In addition to this, the legend on the page is improved, by adding the Legend section and subsection for each of the columns.
The only other thing we may want to do is to move the Legend section after the table. Let me know what you think about this.
Link for review of the page - https://deploy-preview-23961--material-ui.netlify.app/system/properties/