Astro image service

Unpic can transform images with Astro image service using the astro provider. It can be used with Unpic framework components, or you can use the base unpic libary to generate image URLs directly.

You can import the astro provider from the unpic package using a subpath import:

import { transform } from 'unpic/providers/astro';

If using an Unpic component, you can optionally pass custom operations and options to the component using an object with a astro key. This is lets you use extra features supported by Astro image service, or set custom configuration options.

This example uses @unpic/astro, but the same applies to any Unpic component:

---
import { Image } from '@unpic/astro';
---
<Image
  src="image.jpg"
  width={800}
  height={600}
  options={{
      "astro": {
      // astro options here
      }
  }}
  operations={{
      "astro": {
      // astro operations here
      }
  }}
/>

In supported frameworks you can also import the base component and pass the transformer to it directly. This lets you create a custom component that doesn’t need to include and other transformer code.

---
import { Image } from '@unpic/astro/base';
import { transform } from 'unpic/providers/astro';
---
<Image
  src="image.jpg"
  width={800}
  height={600}
  transformer={transformer}
/>

Types

The astro provider supports the following arguments:

Options

baseUrl

Type: string

endpoint

Type: string

Operations

w

Type: number

h

Type: number

f

Type: ImageFormat

q

Type: number

fit

Type: "contain" | "cover" | "fill" | "none" | "scale-down"

width

Type: string | number

height

Type: string | number

format

Type: (string & {}) | ImageFormat

quality

Type: string | number

This page is auto-generated from the astro provider types. See anything wrong or missing? Suggest a change on GitHub.