feat(Avatar): Support overriding the Avatar img element. Fixes #482 #483
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
It accomplishes this by changing the `img` prop to either be a string or a render prop that returns a React element. That makes it so any of the props can be overridden, or an entirely different element could be used in its place. The docs site doesn't support the render prop syntax by default, so I added a small extension that allows the docs pages to provide a `rawCode` property which is passed directly to the syntax highlighter instead of generating the code sample from the `code` JSX. Includes a new passing test and a Storybook example.
Codecov ReportBase: 97.36% // Head: 97.37% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #483 +/- ##
=======================================
Coverage 97.36% 97.37%
=======================================
Files 127 127
Lines 5358 5364 +6
Branches 441 443 +2
=======================================
+ Hits 5217 5223 +6
Misses 141 141
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
LGTM, I think the logic in this component is getting a bit complicated to read but I don't know how to fix that at all. |
tulup-conner
approved these changes
Dec 11, 2022
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.
Description
Changes the Avatar
imgprop to either be a string or a render prop that returns a React element. That makes it so any of the props can be overridden, or an entirely different element could be used in its place.The docs site doesn't support the render prop syntax by default, so I added a small extension that allows the docs pages to provide a
rawCodeproperty which is passed directly to the syntax highlighter instead of generating the code sample from thecodeJSX.Fixes #482
Type of change
How Has This Been Tested?
Checklist: