IPX

Unpic can transform images with IPX using the ipx 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 ipx provider from the unpic package using a subpath import:

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

If using an Unpic component, you can optionally pass custom operations and options to the component using an object with a ipx key. This is lets you use extra features supported by IPX, 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={{
      "ipx": {
      // ipx options here
      }
  }}
  operations={{
      "ipx": {
      // ipx 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/ipx';
---
<Image
  src="image.jpg"
  width={800}
  height={600}
  transformer={transformer}
/>

Types

The ipx provider supports the following arguments:

Options

baseURL

Type: string

Operations

w

Type: number

Width of the image in pixels.

h

Type: number

Height of the image in pixels.

s

Type: string

Combined size parameter. Example: “300x200”

q

Type: number

Quality of the image (1-100).

f

Type: ImageFormat | "auto"

Output format of the image.

width

Type: string | number

height

Type: string | number

format

Type: (string & {}) | ImageFormat

quality

Type: string | number

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