Hygraph

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

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

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

Types

The hygraph provider supports the following arguments:

Options

region

Type: string

envId

Type: string

handle

Type: string

Operations

fit

Type: "crop" | "scale" | "clip" | "max"

Fit mode for resizing.

width

Type: string | number

height

Type: string | number

format

Type: (string & {}) | ImageFormat

quality

Type: string | number

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