-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/tsconfck
- Loading branch information
Showing
27 changed files
with
530 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'astro': patch | ||
--- | ||
|
||
Fix markdown page charset to be utf-8 by default (same as Astro 2) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
'astro': minor | ||
--- | ||
|
||
Adds experimental support for generating `srcset` attributes and a new `<Picture />` component. | ||
|
||
## `srcset` support | ||
|
||
Two new properties have been added to `Image` and `getImage()`: `densities` and `widths`. | ||
|
||
These properties can be used to generate a `srcset` attribute, either based on absolute widths in pixels (e.g. [300, 600, 900]) or pixel density descriptors (e.g. `["2x"]` or `[1.5, 2]`). | ||
|
||
|
||
```astro | ||
--- | ||
import { Image } from "astro"; | ||
import myImage from "./my-image.jpg"; | ||
--- | ||
<Image src={myImage} width={myImage.width / 2} densities={[1.5, 2]} alt="My cool image" /> | ||
``` | ||
|
||
```html | ||
<img | ||
src="/_astro/my_image.hash.webp" | ||
srcset="/_astro/my_image.hash.webp 1.5x, /_astro/my_image.hash.webp 2x" | ||
alt="My cool image" | ||
/> | ||
``` | ||
|
||
## Picture component | ||
|
||
The experimental `<Picture />` component can be used to generate a `<picture>` element with multiple `<source>` elements. | ||
|
||
The example below uses the `format` property to generate a `<source>` in each of the specified image formats: | ||
|
||
```astro | ||
--- | ||
import { Picture } from "astro:assets"; | ||
import myImage from "./my-image.jpg"; | ||
--- | ||
<Picture src={myImage} formats={["avif", "webp"]} alt="My super image in multiple formats!" /> | ||
``` | ||
|
||
The above code will generate the following HTML, and allow the browser to determine the best image to display: | ||
|
||
```html | ||
<picture> | ||
<source srcset="..." type="image/avif" /> | ||
<source srcset="..." type="image/webp" /> | ||
<img src="..." alt="My super image in multiple formats!" /> | ||
</picture> | ||
``` | ||
|
||
The `Picture` component takes all the same props as the `Image` component, including the new `densities` and `widths` properties. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
import { getImage, type LocalImageProps, type RemoteImageProps } from 'astro:assets'; | ||
import type { GetImageResult, ImageOutputFormat } from '../dist/@types/astro'; | ||
import { isESMImportedImage } from '../dist/assets/internal'; | ||
import { AstroError, AstroErrorData } from '../dist/core/errors/index.js'; | ||
import type { HTMLAttributes } from '../types'; | ||
type Props = (LocalImageProps | RemoteImageProps) & { | ||
formats?: ImageOutputFormat[]; | ||
fallbackFormat?: ImageOutputFormat; | ||
pictureAttributes?: HTMLAttributes<'picture'>; | ||
}; | ||
const { formats = ['webp'], pictureAttributes = {}, ...props } = Astro.props; | ||
if (props.alt === undefined || props.alt === null) { | ||
throw new AstroError(AstroErrorData.ImageMissingAlt); | ||
} | ||
const optimizedImages: GetImageResult[] = await Promise.all( | ||
formats.map( | ||
async (format) => | ||
await getImage({ ...props, format: format, widths: props.widths, densities: props.densities }) | ||
) | ||
); | ||
const fallbackFormat = | ||
props.fallbackFormat ?? isESMImportedImage(props.src) | ||
? ['svg', 'gif'].includes(props.src.format) | ||
? props.src.format | ||
: 'png' | ||
: 'png'; | ||
const fallbackImage = await getImage({ | ||
...props, | ||
format: fallbackFormat, | ||
widths: props.widths, | ||
densities: props.densities, | ||
}); | ||
const additionalAttributes: Record<string, any> = {}; | ||
if (fallbackImage.srcSet.values.length > 0) { | ||
additionalAttributes.srcset = fallbackImage.srcSet.attribute; | ||
} | ||
--- | ||
|
||
<picture {...pictureAttributes}> | ||
{ | ||
Object.entries(optimizedImages).map(([_, image]) => ( | ||
<source | ||
srcset={`${image.src}${ | ||
image.srcSet.values.length > 0 ? ' , ' + image.srcSet.attribute : '' | ||
}`} | ||
type={'image/' + image.options.format} | ||
/> | ||
)) | ||
} | ||
<img src={fallbackImage.src} {...additionalAttributes} {...fallbackImage.attributes} /> | ||
</picture> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.