[docs] Add a composition section #6049
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
|
Doesn't appear like a numbered lists
|
mbrookes
previously requested changes
Feb 1, 2017
docs/customization/composition.md
Outdated
|
|
||
| In order to provide the maximum flexibility and performance, | ||
| we need a way to know the nature of the children elements components | ||
| receive as property. |
There was a problem hiding this comment.
"the child elements a component receives"?
docs/customization/composition.md
Outdated
| with a `muiName` static property. | ||
|
|
||
| However, users like to wrap components in order to enhance them. | ||
| That's conflicting with our `muiName` solution. |
There was a problem hiding this comment.
"to enhance them, which can conflict with our muiName solution.
docs/customization/composition.md
Outdated
| In order to provide the maximum flexibility and performance, | ||
| we need a way to know the nature of the children elements components | ||
| receive as property. | ||
| To solve that problem we tag some of our components when needed |
docs/customization/composition.md
Outdated
|
|
||
| However, users like to wrap components in order to enhance them. | ||
| That's conflicting with our `muiName` solution. | ||
| If you encounter that issue, you need to: |
docs/customization/composition.md
Outdated
| That's conflicting with our `muiName` solution. | ||
| If you encounter that issue, you need to: | ||
| 1. Forward the properties. | ||
| 2. Use the same tag for your wrapping component that used with the wrapped component. |
|
|
||
| ## API consistency | ||
|
|
||
| You may have noticed some inconsistency in our API regarding composting components. |
There was a problem hiding this comment.
composting components
😆 We have a few of those on master!
docs/customization/composition.md
Outdated
| To provide some transparency, we have been using the following rules when designing the API: | ||
|
|
||
| 1. Using the `children` property is the idiomatic way to do composition with React. | ||
| 2. When we need limited children composition, providing explicit property is making the implementation simpler and more performant. For instance, the `<Tab />` takes an `icon` and a `label` property. |
There was a problem hiding this comment.
When we need limited children composition
"limited child composition" perhaps? But what does that mean?
You missed one! |
|
Oups 🍂 |
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.
Closes #6041.