Directus

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

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

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

Types

The directus provider supports the following arguments:

Options

The directus provider does not support any extra configuration options.

Operations

fit

Type: "contain" | "cover" | "inside" | "outside"

withoutEnlargement

Type: boolean

transforms

Type: string | [operation: string, ...(string | number | boolean)[]][]

For advanced control over the file generation, Directus exposes the full sharp API. Pass an array of operations to apply to the image, or a JSON string.

width

Type: string | number

height

Type: string | number

format

Type: ImageFormat | "auto"

quality

Type: string | number

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