Storyblok

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

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

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

Types

The storyblok provider supports the following arguments:

Options

The storyblok provider does not support any extra configuration options.

Operations

crop

Type: string

filters

Type: Record<string, string>

flipx

Type: "-"

flipy

Type: "-"

width

Type: string | number

height

Type: string | number

format

Type: ImageFormat | (string & {})

quality

Type: string | number

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