Skip to content
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.

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

[docs] Document the global class names #16770

Merged
merged 1 commit into from
Jul 27, 2019

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jul 26, 2019

This is something I wanted to work on since the release of v4 and the introduction of global class names:

Capture d’écran 2019-07-27 à 01 53 21

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jul 26, 2019
@mui-pr-bot
Copy link

mui-pr-bot commented Jul 27, 2019

No bundle size changes comparing bff38c1...b3bf589

Generated by 🚫 dangerJS against b3bf589

@oliviertassinari oliviertassinari force-pushed the docs-global-class-names branch from b920dde to d67aab8 Compare July 27, 2019 00:02
@oliviertassinari oliviertassinari force-pushed the docs-global-class-names branch from d67aab8 to b3bf589 Compare July 27, 2019 00:08

If using the \`overrides\` [key of the theme](/customization/themes/#css),
you need to use the following style sheet name: \`${reactAPI.styles.name}\`.
If it's not enough, you can find the [implementation of the component](${SOURCE_CODE_ROOT_URL}${normalizePath(
Copy link
Member

Choose a reason for hiding this comment

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

👍

@joshwooding
Copy link
Member

This is a massive improvement to the customisation documentation 🎉

@oliviertassinari oliviertassinari deleted the docs-global-class-names branch July 27, 2019 20:59
Copy link
Member

@mbrookes mbrookes left a comment

Choose a reason for hiding this comment

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

Would have helped if I'd clicked submit 🤦🏻‍♂️

reactAPI.filename,
)})
for more detail.
You can override the style of the component thanks to one of these customizability points:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can override the style of the component thanks to one of these customizability points:
You can override the style of the component thanks to one of these customization points:


If using the `overrides` [key of the theme](/customization/themes/#css),
you need to use the following style sheet name: `MuiAvatar`.
If it's not enough, you can find the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Avatar/Avatar.js) for more detail.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If it's not enough, you can find the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Avatar/Avatar.js) for more detail.
If that's not sufficient, you can check the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Avatar/Avatar.js) for more detail.

@joshwooding
Copy link
Member

Would have helped if I'd clicked submit 🤦🏻‍♂️

My bad!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants