From 9f1c594fa2272e819a7349b74c262c2253e3a9e9 Mon Sep 17 00:00:00 2001 From: DeltaImpact Date: Thu, 5 Nov 2026 12:09:30 +0100 Subject: [PATCH] Add lazy loading for images on blog posts previews and inside, except for emoji images - #57 --- src/components/commons/LazyLoadImage.test.tsx | 102 ++++++++++++++++++ src/components/commons/LazyLoadImage.tsx | 102 ++++++++++++++++++ src/components/commons/index.ts | 3 +- src/features/blog/components/BlogPostList.tsx | 26 ++--- .../blog/components/BlogPostRender.tsx | 32 +++--- .../blog/components/BlogPostThumbnail.tsx | 8 +- .../markdown/MarkdownImgOverride.tsx | 8 +- 7 files changed, 238 insertions(+), 43 deletions(-) create mode 100644 src/components/commons/LazyLoadImage.test.tsx create mode 100644 src/components/commons/LazyLoadImage.tsx diff --git a/src/components/commons/LazyLoadImage.test.tsx b/src/components/commons/LazyLoadImage.test.tsx new file mode 100644 index 0000000..319c7d4 --- /dev/null +++ b/src/components/commons/LazyLoadImage.test.tsx @@ -0,0 +1,102 @@ +import { + describe, + it, + vi, + expect, + afterAll, +} from "vitest"; +import { render, fireEvent } from "@solidjs/testing-library"; +import { LazyLoadImage } from "./LazyLoadImage"; + +const getSkeleton = (container: HTMLElement) => + container.querySelector(".animate-pulse"); + +const mockImageState = (isComplete: boolean, isNaturalWidth: number) => { + vi.spyOn(HTMLImageElement.prototype, "complete", "get").mockReturnValue( + isComplete + ); + vi.spyOn(HTMLImageElement.prototype, "naturalWidth", "get").mockReturnValue( + isNaturalWidth + ); +}; + +afterAll(() => { + vi.restoreAllMocks(); +}); + +describe("LazyLoadImage", () => { + it("when loading image show skeleton", async () => { + mockImageState(false, 0); + + const { container } = render(() => ( + + )); + const image = container.querySelector("img")!; + + expect(getSkeleton(container)).toBeTruthy(); + expect(image?.className).toContain("opacity-0"); + }); + + it("when loaded image hide skeleton and show image", async () => { + mockImageState(false, 0); + const { container } = render(() => ( + + )); + const image = container.querySelector("img")!; + expect(getSkeleton(container)).toBeTruthy(); + expect(image?.className).toContain("opacity-0"); + + fireEvent.load(image); + + expect(getSkeleton(container)).toBeNull(); + expect(image?.className).toContain("opacity-100"); + }); + + it("when image cached before dehydration show image", async () => { + mockImageState(true, 300); + + const { container } = render(() => ( + + )); + const image = container.querySelector("img")!; + + expect(getSkeleton(container)).toBeNull(); + expect(image?.className).toContain("opacity-100"); + }); + + it("when image failed to load show error text", async () => { + mockImageState(false, 0); + const { container, getByTestId } = render(() => ( + + )); + const image = container.querySelector("img")!; + + fireEvent.error(image); + + expect(getSkeleton(container)).toBeNull(); + const imageFailure = getByTestId("image-failure"); + expect(imageFailure.innerText).toBe("Failed To Load Image"); + expect(image?.className).toContain("opacity-0"); + }); + + it("when provided image classes should apply them", () => { + mockImageState(false, 0); + let imageRef: HTMLImageElement | undefined; + const onLoad = vi.fn(); + + const { container } = render(() => ( + (imageRef = element)} + onLoad={onLoad} + /> + )); + + expect(container.firstElementChild?.className).toContain("h-42"); + const image = container.querySelector("img")!; + expect(imageRef).toBe(image); + expect(image.className).toContain("object-cover"); + }); +}); diff --git a/src/components/commons/LazyLoadImage.tsx b/src/components/commons/LazyLoadImage.tsx new file mode 100644 index 0000000..65cdaf4 --- /dev/null +++ b/src/components/commons/LazyLoadImage.tsx @@ -0,0 +1,102 @@ +import clsx from "clsx"; +import { + Component, + createSignal, + onCleanup, + onMount, + Show, + splitProps, +} from "solid-js"; +import type { JSX } from "solid-js"; + +export interface LazyLoadImageProps extends JSX.ImgHTMLAttributes { + containerClasses?: string; + imageClasses?: string; + skeletonClasses?: string; +} + +export const LazyLoadImage: Component = ( + props +) => { + const [local, others] = splitProps(props, [ + "containerClasses", + "imageClasses", + "skeletonClasses", + "ref", + ]); + + const [isLoaded, setIsLoaded] = createSignal(false); + const [isFailed, setIsFailed] = createSignal(false); + + let imageRef: HTMLImageElement | undefined; + + onMount(() => { + const image = imageRef; + if (!image) return; + + const markLoaded = () => { + setIsLoaded(true); + setIsFailed(false); + }; + + const markLoadingError = () => { + setIsLoaded(false); + setIsFailed(true); + }; + + image.addEventListener("load", markLoaded); + image.addEventListener("error", markLoadingError); + + onCleanup(() => { + image.removeEventListener("load", markLoaded); + image.removeEventListener("error", markLoadingError); + }); + + if (image.complete) { + if (image.naturalWidth > 0) markLoaded(); + else markLoadingError(); + } + }); + + const isShowSkeleton = () => !isLoaded() && !isFailed(); + const isHideImage = () => isShowSkeleton() || isFailed(); + + return ( +
+ + + ); +}; diff --git a/src/components/commons/index.ts b/src/components/commons/index.ts index bf6916f..7328b03 100644 --- a/src/components/commons/index.ts +++ b/src/components/commons/index.ts @@ -4,4 +4,5 @@ export { Drawer } from "./Drawer"; export { FAQSection } from "./FAQSection"; export { MarkdownLink } from "./Markdown"; export { Typography } from "./Typography"; -export { Button } from "./Button/Button"; \ No newline at end of file +export { Button } from "./Button/Button"; +export { LazyLoadImage } from "./LazyLoadImage"; diff --git a/src/features/blog/components/BlogPostList.tsx b/src/features/blog/components/BlogPostList.tsx index fbcb031..fad2705 100644 --- a/src/features/blog/components/BlogPostList.tsx +++ b/src/features/blog/components/BlogPostList.tsx @@ -3,7 +3,7 @@ import { BlogPostMetadata, BlogYearGroup } from "../blog.types"; import { A } from "@solidjs/router"; import clsx from "clsx"; import { FormattedDate } from "./FormattedDate"; -import { Typography } from "~/components/commons"; +import { LazyLoadImage, Typography } from "~/components/commons"; import { BlogPostThumbnail } from "./BlogPostThumbnail"; import { getBlogPostThumbnailPlaceholderAttributes } from "../utils/blog.thumbnail.helper"; @@ -80,25 +80,11 @@ const BlogPostCard: Component<{ post: BlogPostMetadata }> = (props) => { /> } > -
-
- - {props.post.title} -
+
diff --git a/src/features/blog/components/BlogPostRender.tsx b/src/features/blog/components/BlogPostRender.tsx index 6bbe581..ae216f6 100644 --- a/src/features/blog/components/BlogPostRender.tsx +++ b/src/features/blog/components/BlogPostRender.tsx @@ -1,6 +1,10 @@ import { Meta, Title } from "@solidjs/meta"; import { Component, createMemo, Show } from "solid-js"; -import { Container, Typography } from "~/components/commons"; +import { + Container, + LazyLoadImage, + Typography, +} from "~/components/commons"; import { FormattedDate, MarkdownContentRender } from "~/features/blog"; import { BlogPost } from "~/features/blog/blog.types"; import { extractBlogHeadings } from "../utils/blog-table-of-contents.helper"; @@ -77,7 +81,13 @@ const BlogPostHeader: Component = (props) => { when={props.post.metadata.thumbnailUrl} fallback={} > - +
@@ -94,23 +104,13 @@ const BlogPostThumbnailPlaceholder: Component = ( return (
-
); }; - -const BlogPostThumbnailImage: Component = (props) => { - return ( -
- {props.post.metadata.title} -
- ); -}; diff --git a/src/features/blog/components/BlogPostThumbnail.tsx b/src/features/blog/components/BlogPostThumbnail.tsx index 58e0e34..1ffef50 100644 --- a/src/features/blog/components/BlogPostThumbnail.tsx +++ b/src/features/blog/components/BlogPostThumbnail.tsx @@ -1,6 +1,7 @@ import { Component } from "solid-js"; import { BlogPostThumbnailPlaceholder } from "../utils/blog.thumbnail.helper"; import clsx from "clsx"; +import { LazyLoadImage } from "~/components/commons"; interface BlogPostThumbnailProps { title: string; @@ -45,11 +46,12 @@ export const BlogPostThumbnail: Component = (props) => {
- {props.title} ); diff --git a/src/features/blog/components/markdown/MarkdownImgOverride.tsx b/src/features/blog/components/markdown/MarkdownImgOverride.tsx index ad12c5b..2cbb703 100644 --- a/src/features/blog/components/markdown/MarkdownImgOverride.tsx +++ b/src/features/blog/components/markdown/MarkdownImgOverride.tsx @@ -1,5 +1,6 @@ import { SolidMarkdownComponents } from "solid-markdown"; import { resolveAssetPath } from "../../utils/blog.helper"; +import { LazyLoadImage } from "~/components/commons"; export function markdownImgOverride( postId: string @@ -29,11 +30,12 @@ export function markdownImgOverride( } return ( - ); };