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.

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

Fixes #271 #274

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

jens-struct
Copy link

@jens-struct jens-struct commented Jan 17, 2025

@zachleat This is the PR for #271, it optimizes the js api for cropping.

I left some comments in the code to start some discussions.

optimize js api for cropping
@@ -415,7 +415,8 @@ class Image {
"sharpWebpOptions",
"sharpPngOptions",
"sharpJpegOptions",
"sharpAvifOptions"
"sharpAvifOptions",
"cacheKey"
Copy link
Author

@jens-struct jens-struct Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of this we could duplicate the logic of https://github.com/11ty/eleventy-img/blob/main/src/image.js#L142 here, but this would mean a not pretty workaround like:

    transform: {[cacheKey]: function(sharp, stats) {
      sharp.resize({
        width: stats.width,
        height: Math.floor(stats.width / cropRatio),
        fit: Sharp.fit.cover,
        position: Sharp.strategy.entropy,
      });
    }}[cacheKey],

where:

  cacheKey: 16 / 9

is way cleaner if you ask me 😅 So i arrived at the solution i pushed here, to be able to influence the hash part of the filename if needed. Please see the sample-crop.js for the usecase.

Also the naming of this option could maybe be improved, i.e. hashKey?

const src = "../test/bio-2017.jpg";
const cropRatio = 16 / 7;

async function sanitizeWidths(widths) {
Copy link
Author

@jens-struct jens-struct Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This removes all widths that would cause upscaling of the original image.

I could probably go a step further and try to build this kind of sanitization into 11ty image.

return sanitizedWidths;
}

function getMaxCropWidth(originalWidth, originalHeight) {
Copy link
Author

@jens-struct jens-struct Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This gets the max width for cropping without upscaling the original image.

I guess this is also a nice thing to have in the core? Although an opt-in through an option is probably a good idea, as it is likely not the wanted behavior for all usecases.

@jens-struct jens-struct marked this pull request as ready for review January 17, 2025 18:05
@@ -681,7 +682,7 @@ class Image {
throw new Error("Expected `function` type in `transform` option. Received: " + transform);
}

await transform(sharpInstance);
await transform(sharpInstance, { ...stat });
Copy link
Author

@jens-struct jens-struct Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably better to pass a clone instead of a reference here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant