refactor(Card): extract image - #6066
Merged
Merged
Conversation
Settle on a single image type to avoid parallel branches that are harder to reason about. Allow optional parameters not to be set
|
Size Change: -578 kB (-26%) 🎉 Total Size: 1.68 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the changes in this PRLighthouse tested 2 URLs Report for Article
Report for Front
|
OllysCoding
reviewed
Sep 27, 2022
| imageUrl?: string; | ||
| avatarUrl?: string; | ||
| }): { type: CardImageType; src: string } | undefined => { | ||
| if (avatarUrl) return { type: 'avatar', src: avatarUrl }; |
Contributor
There was a problem hiding this comment.
This logic looks to be wrong? The previous lines:
if (imageUrl && avatarUrl) {
imageType = 'avatar';
}So this should be
if (avatarUrl && imageUrl) return { type: 'avatar', src: avatarUrl };That said I don't think I fully understand why this logic is the way it is
Contributor
Author
There was a problem hiding this comment.
I could not figure it out either, and this causes no visual difference, so tempted to simplify it like so.
If we want to capture a missing imageUrl and a set avatarUrl, we should have a story against it.
Contributor
There was a problem hiding this comment.
I agree the previous logic is a bit weird and I prefer the new version. I'll leave this up to the two of you. On my side, I'm happy with this PR so I have approved.
ioannakok
reviewed
Sep 27, 2022
| imagePosition: ImagePositionType, | ||
| imagePositionOnMobile: ImagePositionType, | ||
| imagePosition?: ImagePositionType, | ||
| imagePositionOnMobile?: ImagePositionType, |
Contributor
There was a problem hiding this comment.
Not sure I understand why these two are changing to optional. In the Props types they remain non-optional: https://github.com/guardian/dotcom-rendering/blob/main/dotcom-rendering/src/web/components/Card/components/CardLayout.tsx#L7-L8
And in Card.tsx above I see this:
Contributor
Author
There was a problem hiding this comment.
You are right, I have now fixed this in b27392f
mxdvl
commented
Sep 27, 2022
Co-authored-by: Max Duval <max.duval@guardian.co.uk>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this change?
Settle on a single image value to avoid parallel branches that are harder to reason about.
Allow optional parameters not to be set.
Why?
I was looking at this code, and this seemed like a worthwile refactor.
This reduces the amount HTML on Cards without an image, including the
imgtag without asrcattribute.Screenshots
No change, as can be glanced by the absence of Chromatic diffs.