Skip to content

feat: add skeletonDuringImageLoad prop to CardImageCap #3992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brian-smith-tcril merged 1 commit into from
Nov 17, 2025
Merged

feat: add skeletonDuringImageLoad prop to CardImageCap #3992

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 45 additions & 28 deletions src/Card/CardImageCap.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,38 @@ const CardImageCap = React.forwardRef(({
logoSkeletonWidth,
className,
imageLoadingType,
skeletonDuringImageLoad,
}, ref) => {
const { orientation, isLoading } = useContext(CardContext);
const [showImageCap, setShowImageCap] = useState(false);
const [showLogoCap, setShowLogoCap] = useState(false);

const wrapperClassName = `pgn__card-wrapper-image-cap ${orientation}`;

const loadingSkeleton = () => (
<Skeleton
containerClassName="pgn__card-image-cap-loader"
height={orientation === 'horizontal' ? '100%' : skeletonHeight}
width={skeletonWidth}
/>
);

const loadingLogoSkeleton = () => (
<Skeleton
containerClassName="pgn__card-logo-cap"
height={logoSkeletonHeight}
width={logoSkeletonWidth}
/>
);

if (isLoading) {
return (
<div
className={classNames(wrapperClassName, className)}
data-testid="image-loader-wrapper"
>
<Skeleton
containerClassName="pgn__card-image-cap-loader"
height={orientation === 'horizontal' ? '100%' : skeletonHeight}
width={skeletonWidth}
/>
{logoSkeleton && (
<Skeleton
containerClassName="pgn__card-logo-cap"
height={logoSkeletonHeight}
width={logoSkeletonWidth}
/>
)}
{loadingSkeleton()}
{logoSkeleton && loadingLogoSkeleton()}
</div>
);
}
Expand All @@ -70,24 +77,30 @@ const CardImageCap = React.forwardRef(({
return (
<div className={classNames(className, wrapperClassName)} ref={ref}>
{!!src && (
<img
className={classNames('pgn__card-image-cap', { show: showImageCap })}
src={src}
onError={(event) => handleSrcFallback(event, fallbackSrc, 'imageCap')}
onLoad={() => setShowImageCap(true)}
alt={srcAlt}
loading={imageLoadingType}
/>
<>
{skeletonDuringImageLoad && !showImageCap && loadingSkeleton()}
<img
className={classNames('pgn__card-image-cap', { show: showImageCap })}
src={src}
onError={(event) => handleSrcFallback(event, fallbackSrc, 'imageCap')}
onLoad={() => setShowImageCap(true)}
alt={srcAlt}
loading={imageLoadingType}
/>
</>
)}
{!!logoSrc && (
<img
className={classNames('pgn__card-logo-cap', { show: showLogoCap })}
src={logoSrc}
onError={(event) => handleSrcFallback(event, fallbackLogoSrc, 'logoCap')}
onLoad={() => setShowLogoCap(true)}
alt={logoAlt}
loading={imageLoadingType}
/>
<>
{skeletonDuringImageLoad && !showLogoCap && loadingLogoSkeleton()}
<img
className={classNames('pgn__card-logo-cap', { show: showLogoCap })}
src={logoSrc}
onError={(event) => handleSrcFallback(event, fallbackLogoSrc, 'logoCap')}
onLoad={() => setShowLogoCap(true)}
alt={logoAlt}
loading={imageLoadingType}
/>
</>
)}
</div>
);
Expand Down Expand Up @@ -120,6 +133,9 @@ CardImageCap.propTypes = {
logoSkeletonWidth: PropTypes.number,
/** Specifies loading type for images */
imageLoadingType: PropTypes.oneOf(['eager', 'lazy']),
/** Render the loading skeleton when the image is loading in
* addition to when the whole card is in `isLoading` state */
skeletonDuringImageLoad: PropTypes.bool,
};

CardImageCap.defaultProps = {
Expand All @@ -136,6 +152,7 @@ CardImageCap.defaultProps = {
skeletonWidth: undefined,
logoSkeletonWidth: undefined,
imageLoadingType: 'eager',
skeletonDuringImageLoad: false,
};

export default CardImageCap;