Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(picture): support sizes attribute #482

Merged
merged 4 commits into from
Sep 5, 2023
Merged

feat(picture): support sizes attribute #482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57382bb
feat(picture): support `sizes` attribute
cawa-93 Sep 5, 2023
1ce96c2
test: rollback tests
cawa-93 Sep 5, 2023
be04a86
use width dimension descriptors only if `sizes` provided
cawa-93 Sep 5, 2023
c3433ab
deno fmt
cawa-93 Sep 5, 2023
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
30 changes: 26 additions & 4 deletions plugins/picture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,35 @@ export default function (): Plugin {
basePath: string,
) {
const src = img.getAttribute("src") as string;
const sizes = img.getAttribute("sizes");
const sourceFormats = saveTransform(basePath, src, imagick);

for (const sourceFormat of sourceFormats) {
const source = createSource(img.ownerDocument!, src, sourceFormat);
const source = createSource(
img.ownerDocument!,
src,
sourceFormat,
sizes,
);
picture.insertBefore(source, img);
}
}

function handleImg(imagick: string, img: Element, basePath: string) {
const src = img.getAttribute("src") as string;
const sizes = img.getAttribute("sizes");
const sourceFormats = saveTransform(basePath, src, imagick);
const picture = img.ownerDocument!.createElement("picture");

img.replaceWith(picture);

for (const sourceFormat of sourceFormats) {
const source = createSource(img.ownerDocument!, src, sourceFormat);
const source = createSource(
img.ownerDocument!,
src,
sourceFormat,
sizes,
);
picture.append(source);
}

Expand Down Expand Up @@ -194,19 +206,29 @@ function createSource(
document: Document,
src: string,
srcFormat: SourceFormat,
sizes?: string | null | undefined,
) {
const source = document.createElement("source");
const { scales, format } = srcFormat;
const { scales, format, width } = srcFormat;
const path = encodeURI(getPathAndExtension(src)[0]);
const srcset: string[] = [];

for (const [suffix, scale] of Object.entries(scales)) {
const scaleSuffix = scale === 1 ? "" : ` ${scale}x`;
const scaleSuffix = sizes
? ` ${scale * width}w`
: scale === 1
? ""
: ` ${scale}x`;
srcset.push(`${path}${suffix}.${format}${scaleSuffix}`);
}

source.setAttribute("srcset", srcset.join(", "));
source.setAttribute("type", typeByExtension(format));

if (sizes) {
source.setAttribute("sizes", sizes);
}

return source;
}

Expand Down
48 changes: 48 additions & 0 deletions tests/__snapshots__/picture.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ snapshot[`imagick plugin 3`] = `
</head>

<body>

<!-- without sizes -->
<div>
<picture><source srcset="/kevin%20schmid%20unsplash-600w.png, /kevin%20schmid%[email protected] 2x" type="image/png"><img src="/kevin schmid unsplash.jpg"></picture>
</div>
Expand All @@ -125,6 +127,20 @@ snapshot[`imagick plugin 3`] = `
<picture><source srcset="/kevin%20schmid%20unsplash-300w.avif, /kevin%20schmid%[email protected] 2x" type="image/avif"><source srcset="/kevin%20schmid%20unsplash-300w.webp, /kevin%20schmid%[email protected] 2x" type="image/webp"><source srcset="/kevin%20schmid%20unsplash-300w.jpg, /kevin%20schmid%[email protected] 2x" type="image/jpeg"><img src="/kevin schmid unsplash.jpg"></picture>


<!-- with sizes -->
<div>
<picture><source srcset="/kevin%20schmid%20unsplash-600w.png 600w, /kevin%20schmid%[email protected] 1200w" type="image/png" sizes="600px"><img src="/kevin schmid unsplash.jpg" sizes="600px"></picture>
</div>


<picture>
<source srcset="/kevin%20schmid%20unsplash-600w.avif 600w, /kevin%20schmid%[email protected] 1200w" type="image/avif" sizes="600px"><source srcset="/kevin%20schmid%20unsplash-600w.webp 600w, /kevin%20schmid%[email protected] 1200w" type="image/webp" sizes="600px"><source srcset="/kevin%20schmid%20unsplash-600w.jpg 600w, /kevin%20schmid%[email protected] 1200w" type="image/jpeg" sizes="600px"><img src="/kevin schmid unsplash.jpg" sizes="600px">
</picture>

<!-- This image will be converted to a picture -->
<picture><source srcset="/kevin%20schmid%20unsplash-300w.avif 300w, /kevin%20schmid%[email protected] 600w" type="image/avif" sizes="600px"><source srcset="/kevin%20schmid%20unsplash-300w.webp 300w, /kevin%20schmid%[email protected] 600w" type="image/webp" sizes="600px"><source srcset="/kevin%20schmid%20unsplash-300w.jpg 300w, /kevin%20schmid%[email protected] 600w" type="image/jpeg" sizes="600px"><img src="/kevin schmid unsplash.jpg" sizes="600px"></picture>


</body></html>',
data: {
children: '<!doctype html>
Expand All @@ -134,6 +150,8 @@ snapshot[`imagick plugin 3`] = `
</head>

<body>

<!-- without sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg">
</div>
Expand All @@ -145,6 +163,20 @@ snapshot[`imagick plugin 3`] = `

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2">


<!-- with sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</div>


<picture imagick="avif webp jpg 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</picture>

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2" sizes="600px">
</body>
</html>
',
Expand All @@ -155,6 +187,8 @@ snapshot[`imagick plugin 3`] = `
</head>

<body>

<!-- without sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg">
</div>
Expand All @@ -166,6 +200,20 @@ snapshot[`imagick plugin 3`] = `

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2">


<!-- with sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</div>


<picture imagick="avif webp jpg 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</picture>

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2" sizes="600px">
</body>
</html>
',
Expand Down
16 changes: 16 additions & 0 deletions tests/assets/picture/index.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
</head>

<body>

<!-- without sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg">
</div>
Expand All @@ -16,5 +18,19 @@

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2">


<!-- with sizes -->
<div imagick="png 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</div>


<picture imagick="avif webp jpg 600@2">
<img src="/kevin schmid unsplash.jpg" sizes="600px">
</picture>

<!-- This image will be converted to a picture -->
<img src="/kevin schmid unsplash.jpg" imagick="avif webp jpg 300@2" sizes="600px">
</body>
</html>