Skip to content

add background property to astro:assets #13149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarah11918 merged 3 commits into from
Jan 27, 2026
Merged

add background property to astro:assets #13149

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0e3e2f
add `background` property to `astro:assets`
sarah11918 Jan 26, 2026
98e97d4
Merge branch 'main' into sarah11918-patch-1
sarah11918 Jan 27, 2026
4239719
Merge branch '5.17.0' into sarah11918-patch-1
sarah11918 Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/content/docs/en/reference/modules/astro-assets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,33 @@ fetchpriority="high"

These individual attributes can still be set manually if you need to customize them further.

#### `background`

<p>

**Type:** `string | undefined`<br />
<Since v="5.17.0" />
</p>

The background color to use when flattening an image to transform it into the requested output `format`.

By default, Sharp uses a black background when flattening an image. Specifying a different background color is especially useful when transforming images with transparent backgrounds to a format that does not support transparency (e.g. `jpeg`):

```astro title="src/components/MyComponent.astro" "background"
---
import { Image } from 'astro:assets';
import myImage from '../assets/my_image.png';
---
<Image
src={myImage}
alt="A description of my image"
format="jpeg"
background="#ffffff"
/>
```

Values are passed directly to the image service. Sharp accepts [any value the `color-string` package can parse](https://github.com/Qix-/color-string/blob/master/README.md#parsing).

### `<Picture />`

<p><Since v="3.3.0" /></p>
Expand Down