docs(astro-assets): clarify getImage() options don't match all Image props#13786
docs(astro-assets): clarify getImage() options don't match all Image props#13786nielskaspers wants to merge 1 commit intowithastro:mainfrom
Conversation
…props The getImage() description claimed options match the Image component properties "except alt", but getImage() accepts UnresolvedImageTransform, which also omits priority and layout (Image-only props). Same wording was used for LocalImageService/ExternalImageService `getImage()`. Closes withastro#13301
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
2 participants
Summary
The reference docs state that `getImage()` takes an options object with "the same properties as the Image component (except `alt`)". That isn't accurate: `getImage()` accepts `UnresolvedImageTransform`, which does not include `priority` or `layout` either — those are `![]()
`-only props.
The same wording was duplicated in the `LocalImageService` / `ExternalImageService` `getImage()` entry, so both are updated.
Issue
Fixes #13301
Changes
Testing