Skip to content

[docs] Document the CSS API #12174

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 19, 2018
Merged

[docs] Document the CSS API #12174

merged 2 commits into from
Jul 19, 2018

Conversation

@mbrookes
Copy link
Member

@mbrookes mbrookes commented Jul 17, 2018

Closes #10389

@mbrookes mbrookes added the docs Improvements or additions to the documentation. label Jul 17, 2018
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 18, 2018

Awesome idea!

@mbrookes
Copy link
Member Author

mbrookes commented Jul 18, 2018 •
edited
Loading

Known issues:

  • Grid & Paper have some programatically generated class keys that are not documented (but these are all self explanatory).

  • Select styles are imported from NativeSelect, so are not documented. (Fixed)

  • Slider empty styles used to trigger JSS nested styles not documented. (Best effort)

oliviertassinari
oliviertassinari reviewed Jul 18, 2018
View reviewed changes
packages/material-ui/src/ButtonBase/ButtonBase.js
cursor: 'default',
},
},
/* Styles applied to the root element if `disabled={true}`. */
Copy link
Member

@oliviertassinari oliviertassinari Jul 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we are going to need a specific wording for the "internal state" rules: https://material-ui.com/customization/overrides/#overriding-with-classes

Copy link
Member

@oliviertassinari oliviertassinari Jul 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People have to increase specificity in this case. It's important to be transparent about it.

Copy link
Member Author

@mbrookes mbrookes Jul 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I hadn't picked up on it there. I'm open to suggestions.

Copy link
Member

@oliviertassinari oliviertassinari Jul 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could have a Type column with 'normal | internal state'.

@oliviertassinari oliviertassinari merged commit a207808 into mui:master Jul 19, 2018
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 19, 2018 •
edited
Loading

@mbrookes Yes, I do love the effort. I think that it's really important to have the CSS API documented. Great work!

@snyk-bot snyk-bot mentioned this pull request Sep 30, 2019
Open
This was referenced Mar 26, 2020
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oliviertassinari oliviertassinari oliviertassinari approved these changes

Assignees

No one assigned

Labels

docs Improvements or additions to the documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mbrookes @oliviertassinari