docs: Add lossy parameter documentation for Stencil image helpers #1064
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the Stencil image helpers documentation to include the new
lossy
parameter based on the implementation in bigcommerce/paper-handlebars#383.What's Changed
New Image Optimization Section
Added a comprehensive overview explaining the benefits of lossy compression:
Updated Image Helper Documentation
All Stencil image helpers now document the optional
lossy
parameter:getImage
- Main image helper for preset-based sizinggetImageSrcset
- Responsive image srcset generationgetContentImage
- Content management image helpergetContentImageSrcset
- Content management srcset helpergetImageManagerImage
- Image manager helpergetImageManagerImageSrcset
- Image manager srcset helperEnhanced Examples
Added practical examples showing how to use the
lossy
parameter:When
lossy=true
is specified, the helpers append?compression=lossy
to the generated URLs, enabling the CDN to apply lossy compression and automatic format conversion.Benefits for Developers
false
, preserving existing behaviorThis documentation update ensures developers have the information they need to leverage the new image optimization capabilities in their Stencil themes.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.