Improve documentation about when the setting of property "muiName" is really necessary

Question and feature request:

In the documentation for v0.19.0 there are some examples, e.g. for AppBar, where the property muiName is set. In most of the other examples in the documentation this property is not set. In the documentation for v1.0.0-beta.7 it reads

[…] we tag some of our components when needed with a muiName static property.

My question would be, what is meant by “when needed”? Most examples don’t set muiName, although they all define React subcomponents and wrap Material-UI components in one way or another. Also see my initial question on stackoverflow.

Could you please elaborate further on when and how to use muiName in the documentation and maybe also update the component examples, in case setting of muiName is missing anywhere due to sloppiness.

[oliviertassinari]

I am a newbie with MUI

Don’t worry, this is an advanced feature. You don’t need to worry about it until you face the issue.

If I knew the answer to that question, I wouldn’t have opened this issue.

The React tree structure is essential to understand the why around the muiName existence. Let’s say we have the following.

<Parent>
  <Icon />
  <Text />
</Parent>

The Parent wants to apply a color property to only the Icon children, but he can also have a Text children. How does he know which children are how? He uses the muiName.

Again, at the end of the day, every component is “wrapped” by another component in the React tree.

I would rather use the composition wording over the wrap one. We refer to wrap at the component level, not the element one.

I hope it’s more clear this way. Sorry I couldn’t go into more details. You can find a better channel than Material-UI issues to learn more about React 😃.

[svdHero]

Thank you for clarifying further Olivier.

You don’t need to worry about it until you face the issue.

That’s fine. How would you I notice if the issue becomes important for me? Would there be warnings in my browser’s javascript console? Or would there just be styling issues?