Releases: 11ty/eleventy-img
Eleventy Image v7.0.0-alpha.1
- Package is now using ESM #300. Now requires
import
,import()
, or require(esm) in Node (v22.12.0, v20.19.0, or newer) to use.- Example (ESM only):
import Image from "@11ty/eleventy-img"
- Example (CommonJS friendly):
const Image = await import("@11ty/eleventy-img")
- Example (ESM only):
- Breaking changes in
[email protected]
upgrade to0.34
: https://sharp.pixelplumbing.com/changelog/#v0340---4th-april-2025 - Major dependency upgrade:
[email protected]
to8.1
#120- ESM-only as of v7 https://github.com/sindresorhus/p-queue/releases/tag/v7.0.0
- Node 18+ as of v8 https://github.com/sindresorhus/p-queue/releases/tag/v8.0.0
Issue Milestone: https://github.com/11ty/eleventy-img/milestone/25?closed=1
Full Changelog: v6.0.4...v.7.0.0-alpha.1
Eleventy Image v6.0.4
Milestone: https://github.com/11ty/eleventy-img/milestone/27?closed=1
Full Changelog: v6.0.3...v6.0.4
Eleventy Image v6.0.3
- Adds Node v24 to CI test suite
- Swap to use the
image-size
asynchronous API internally (when usingstatsOnly
option) #294 - Adds
ImageSize
export to reuse internal image-size package - Reuses multi-runtime hashing utility from
@11ty/[email protected]
- Upgrade devDependencies
- Migrate to flat config with
@stylistic/eslint-plugin-js
by @outslept in #292
Milestone: https://github.com/11ty/eleventy-img/milestone/26?closed=1
Full Changelog: v6.0.2...v6.0.3
Eleventy Image v6.0.2 (dependency bump for security audit)
- bump image-size minimum version for security by @joshvickerson in #290
Milestone: https://github.com/11ty/eleventy-img/milestone/24?closed=1
Full Changelog: v6.0.1...v6.0.2
Eleventy Image v6.0.1 (Tiny Bugfix Release)
- Bug fix when using animated images with
transformOnRequest
#273
Milestone: https://github.com/11ty/eleventy-img/milestone/23?closed=1
Full Changelog: v6.0.0...v6.0.1
Eleventy Image v6.0.0
Notably, for maximum compatibility this package is still CommonJS (not yet ESM). Node minimum is still 18+ (unchanged from Eleventy Image v4).
Breaking Changes
useCacheValidityInHash
option has been removed #146- Transform method will reuse existing
<img width>
attribute (if single integer) aseleventy:widths
value #234
The following changes likely require no action on your part (but are nonetheless breaking):
- Better color support (P3, AdobeRGB, et al): images retain ICC profiles by default #244
- Dependency major upgrade:
@11ty/eleventy-fetch
from v4 to v5 - Dependency major upgrade
@11ty/eleventy-utils
from v1 to v2 - Default metadata object returned will no longer include empty format arrays
{ jpeg: [] }
#242
Features
- Uses native
fetch()
(no morenode-fetch
, viaeleventy-fetch
upgrade) and works better with caching on remote urls, consistency on file names with sync methods #252 #262 #146 returnType: "html"
option will return the generated HTML directly instead of the metadata object #267htmlOptions: {}
are options passed to thegenerateHTML
function
- Output format filtering (opt-out with
formatFiltering
option). Filters out output formats that do not support animation or transparency automatically. - Adds
failOnError: true
option to avoid throwing an error when image processing fails (and failing your build) #225 See also theeleventy:optional
attribute below. - Adds new
transform
hook for running your ownsharp
customizations #52 (comment) (can be used to add custom cropping!) - Improved error messaging when incorrectly using the default export with
eleventyConfig.addPlugin
#263 - Concurrency auto-scales per machine resources (between
8
min and16
max) #258 - Support full URLs in
urlPath
option #239 generateHTML
: Missingsizes
error relaxed when usingloading="lazy"
HTML, swap to usesizes="auto"
instead #207- New
generateHTML
option (also available viahtmlOptions
) forfallback: "smallest"
to choose smallest image for<img>
fallback andwidth
/height
dimensions #265 #129
Transform Method
- Reuse existing
<img width>
attribute (if single integer) aseleventy:widths
value #234 - Adds
eleventy:optional
HTML attribute so that errors in image processing will not fail the build (in different ways) #259- Remove
src
attribute - Leave as-is
eleventy:optional="keep"
- Replace with a transparent Data URI
eleventy:optional="placeholder"
- Remove
- Decode file name paths #253
- Support transforming
<picture>
nodes #214 - Preserve attributes on
img
andpicture
elements #214 (comment) #241 #243 #251 - Fix for relative references when using permalinks with non-index.html file names #236
Full Milestone (×26 issues closed): https://github.com/11ty/eleventy-img/milestone/22?closed=1
Full Changelog (×75 commits, +2,347/-992): v5.0.0...v6.0.0
Prerelease: Eleventy Image v6.0.0-beta.5
- Fix for resize/cropping in
transform
callbacks #52 reported by @jens-struct on https://indieweb.social/@djenz/113789802133432912
Full v6 Milestone: https://github.com/11ty/eleventy-img/milestone/22?closed=1
Full Changelog: v6.0.0-beta.4...v6.0.0-beta.5
Prerelease: Eleventy Image v6.0.0-beta.4
Probably the last beta before v6.0.0 stable.
- Upgrades to
@11ty/eleventy-fetch
to v5.0.2 #262 - Breaking: upgrades
@11ty/eleventy-utils
from v1 to v2.0.0 requires Node 18+ #270 - Breaking: upgrades
entities
from v5 to v6.0.0, release notes: https://github.com/fb55/entities/releases/tag/v6.0.0
Full v6 Milestone: https://github.com/11ty/eleventy-img/milestone/22?closed=1
Full Changelog: v6.0.0-beta.3...v6.0.0-beta.4
Prerelease: Eleventy Image v6.0.0-beta.3
- Use
returnType: "html"
as documented in beta.1 release: https://github.com/11ty/eleventy-img/releases/tag/v6.0.0-beta.1 - Support
htmlOptions.imgAttributes
andhtmlOptions.pictureAttributes
in Image HTML Transform. Preferred to previousdefaultAttributes
object.
Full v6 Milestone: https://github.com/11ty/eleventy-img/milestone/22?closed=1
Full Changelog: v6.0.0-beta.2...v6.0.0-beta.3
Prerelease: Eleventy Image v6.0.0-beta.2
- Fix issue with ignore attribute not being respected when nested inside of picture
<picture><img eleventy:ignore>
related to #214
Full v6 Milestone: https://github.com/11ty/eleventy-img/milestone/22?closed=1
Full Changelog: v6.0.0-beta.1...v6.0.0-beta.2