Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-30 22:03:56 -05:00
Code Issues Activity

Move format option from LocalImageProps to ImageSharedProps (#10642)

Browse source 
* move format to ImageSharedProps

* add changeset

* move quality to shared

* Update lovely-trees-wait.md

Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev>

---------

Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev>
This commit is contained in:
Oliver Speir 2024-04-02 14:24:02 -06:00 committed by GitHub
parent c3916b5206
commit 4f5dc14f31
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 27 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/lovely-trees-wait.md Normal file
View file

@ -0,0 +1,5 @@
---
"astro": patch
---
Fixes typing issues when using `format` and `quality` options with remote images

44
packages/astro/src/assets/types.ts
View file

@ -118,6 +118,28 @@ type ImageSharedProps<T> = T & {
* ```
*/
height?: number | `${number}`;
/**
* Desired output format for the image. Defaults to `webp`.
*
* **Example**:
* ```astro
* <Image src={...} format="avif" alt="..." />
* ```
*/
format?: ImageOutputFormat;
/**
* Desired quality for the image. Value can either be a preset such as `low` or `high`, or a numeric value from 0 to 100.
*
* The perceptual quality of the output image is service-specific.
* For instance, a certain service might decide that `high` results in a very beautiful image, but another could choose for it to be at best passable.
*
* **Example**:
* ```astro
* <Image src={...} quality='high' alt="..." />
* <Image src={...} quality={300} alt="..." />
* ```
*/
quality?: ImageQuality;
} & (
| {
/**
@ -153,28 +175,6 @@ export type LocalImageProps<T> = ImageSharedProps<T> & {
* ```
*/
src: ImageMetadata | Promise<{ default: ImageMetadata }>;
/**
* Desired output format for the image. Defaults to `webp`.
*
* **Example**:
* ```astro
* <Image src={...} format="avif" alt="..." />
* ```
*/
format?: ImageOutputFormat;
/**
* Desired quality for the image. Value can either be a preset such as `low` or `high`, or a numeric value from 0 to 100.
*
* The perceptual quality of the output image is service-specific.
* For instance, a certain service might decide that `high` results in a very beautiful image, but another could choose for it to be at best passable.
*
* **Example**:
* ```astro
* <Image src={...} quality='high' alt="..." />
* <Image src={...} quality={300} alt="..." />
* ```
*/
quality?: ImageQuality;
};
export type RemoteImageProps<T> =