feat: doc-layout components merge classes from props #1618
+182
−41
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
✅ Deploy Preview for aquamarine-blini-95325f ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Summary
Refactored the default MDX components used by
DocLayoutto properly merge theclassNamewith the component's defaultclassName.Added a new "tailwind" utility,
clsxwhich basically merges string (classNames). Does not depend on any external libraries.Notes
All changes should be entirely non-breaking because the user needs to opt-in to adding classNames to the HTML elements. Additionally, very little was changed for each component.
The one exception would be the
Precomponent. In order to properly mergeclassNameintended for the parent and children, the wrapping div withclassName="language-bash"was lifted up outsiderenderChildren. AndrenderChildrenwas moved to module level. It looks functionally the same, but I have not confirmed it yet...TODO
Fix tests...
Related Issue
Closes #1612
Checklist
There is no documentation on how the default MDX components work, so this doesn't need to be documented either.
[ ] Documentation updated (or not required).