Image Service

Resizing images for your site on the fly can be a little challenging to do. Storyblok's image service provides you with high-quality images in different formats and sizes for all devices and platforms! This guide will show you how to configure your images, including the format, layout, type, and image processing options.

You can also find documentation on v1 configuration options for frameworks like Nuxt and Gatsby.

Contents

• Installation

• Using Storyblok image service

• Automatic WebP support detection

• Optimizing images with image service

• Resizing

• Fit-in

• Changing image format

• Image quality optimizations

• Facial detection and smart cropping

• Custom focal point

• Grayscale

• Blur

• Rotation

• Flip

• Brightness

• Rounded corners

• Combining filters

• Manual cropping

• Caching in Image Service

• Migrating from the previous version of image service

Installation / Requirements

Image service is native to Storyblok, you don't have to install anything in your application to use it. However, it's important to note that there are technical limits to image service.

Documentation

You can use Storyblok image service to optimize, resize and crop images for different platforms and devices. To do this, add a /m/ at the end of your asset URL, followed by additional filters and parameters we will learn in this guide.

The image service will transform every image on the Storyblok servers for you, and then sent through our CDN to it as fast as possible.

Here's an example image below:

Automatic WebP support detection

WebP is an image format that is well known for providing better compression compared to other formats. Since smaller images will make your pages load faster, our image service will help you increase your project's speed.

Append /m/ to the end of the image URL, and they will be automatically be served in WebP if your browser supports it. You can force a specific format by using the format filter.

Optimize

You can make your images lighter by simply appending /m/ at the end of the URLs. This will enable server-side WebP support detection without performing any other change on the image.

Example:

https://a.storyblok.com/f/39898/3310x2192/e4ec08624e/demo-image.jpeg/m/

Resizing

Resizing: Static

Resizing: Proportional to Width

Resizing: Proportional to Height

Fit-In

The fit-in argument specifies that the image should not be auto-cropped but auto-resized (shrunk) to fit inside the imaginary width and height box instead.

To fill out the box with a color, use the fill filter filters:fill(CCCCCC) with a hexadecimal RGB expression (without the # character). If you want to fill your image with transparent pixels use filter:fill(transparent) combined with :format(png). This might add transparent pixels and make the asset a png image even with .jpeg
as the file extension of your original image.

Fit-In with CCCCCC background

Fit-In with transparent background

Changing the format

To change the image format, use the format filter. Supported formats are "webp", "jpeg" and "png".

Example:

https://a.storyblok.com/f/39898/3310x2192/e4ec08624e/demo-image.jpeg/m/200x0/filters:format(png)

Quality optimization

You can change the compression rate of your JPEG images using the quality filter. The value can be 0-100.

Resized and 10% Quality

Facial detection and smart cropping

When cropping an image, define a smart filter that crops around the focal point. To use, insert the keyword ‘smart’ after the size definition. In our example, a different demo image since flowers don't have a face.

Resized without Smart Crop

Resized with Smart Crop

Custom focal point

Use the focal point method to define the center of an image, Do this by adding the filter to the URL of the image as shown below:

filters:focal(<left>x<top>:<right>x<bottom>)

Examples:

To focus on the bottom of the image:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x130/filters:focal(450x500:550x600)

Focus on the top of the image:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x130/filters:focal(450x0:550x100)

Manual cropping

You can manually crop specific areas of an image by defining a rectangular cropping area. To do this, declare coordinates for the two points.

The two points of the rectangle are the top-left (first-point) and the bottom-right corners of the rectangle. You have to define the points as pairs of coordinates starting from the top-left corner of the image.

/<left>x<top>:<left>x<top>/

You can also combine cropping with the resizing functionality.

Examples:

To crop a square of 100 pixels starting from the coordinate 300 (x) and 200 (y):

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/300x200:400x300/

Cropping around the focal point

If you want to crop an area around a focal point in your image. Do this by calculating the coordinates of the top-left and bottom-right.

Given your focal point with coordinates X and Y and the size of the area around your point L, calculate the coordinates of the top left corner and bottom right corner of your cropping area with this method:

• top-left x = X - L/2

• top-left y = Y - L/2

• bottom-right x = X + L/2

• bottom-right y = Y + L/2

Examples:

Your focal point has coordinates 400:300 and you want to crop a square of 100 pixels around it.

• top-left x: 400 - 100/2 = 350

• top-left y: 300 - 100/2 = 250

• bottom-right x: 400 + 100/2 = 450

• bottom-right y: 300 + 100/2 = 350
  

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/350x250:450x350

Grayscale

You can serve black and white images with the grayscale() filter.

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x130/filters:grayscale()

Blur

You can blur images with the blur(radius, [sigma]) filter. This is particularly useful for placeholders for lazy-loaded images.
The parameters are:

• radius: An int value between 0 and 150. the higher the number, the more blurred the image will be;

• sigma: Optional. Defaults to the same value as the radius. Sigma is used in the gaussian function for blurring.

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x230/filters:blur(10)

Rotation

You rotate your images with rotate(angle) filter. Angle is a value between 0 and 359.

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/230x230/filters:rotate(90)

Flip

Flip your images with the resizing parameter. Adding a - in front of one of the sizes will make the image flip on the same axis. If you don't need to resize your image, use 0 as a value for that axis.

Examples:

Horizontally flipped image without resizing

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/-0x0

Vertically flipped image without resizing

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/0x-0

Images flipped on both axis with resizing

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/-600x-230

Brightness

Set the brightness of your image with the param, brightness(amount) where the amount is a value between -100 and 100.

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/filters:brightness(80)

Rounded corners

Add rounded corners to your image and define a different radius for each of them with the round_corner(a|b,r,g,b,[transparent]) filter.
The parameters are:

• a is an integer representing the radius size;

• b is optional, and it's another parameter for the ellipsis of the rounded corners;

• r, g, b are the background color outside the rounded corners;

• transparent is an optional value from 0 to 1 to set the opacity of the background color.

filters:round_corner(<top-left>,<top-right>,<bottom-right>,<bottom-left>)

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x230/filters:round_corner(30,255,255,255)

Combining filters

You can combine multiple filters chaining them with colons: You have to write filters: just once at the start of the list.

Examples:

https://a.storyblok.com/f/39898/1000x600/d962430746/demo-image-human.jpeg/m/600x130/filters:focal(450x500:550x600):grayscale()

Caching

With Image service v1, all assets were heavily cached, but with Image service v2, WebP formats are cached automatically.

By default, assets are not cached if you decide to use the automatic WebP detection. To cache, you need to add a URL path + "Accept" in your image header. If the Accept: WebP header exists in the request, the image service will convert to WebP if it does not remain in the original format (The browser is responsible for adding this header)

Once a cache is created using the accept header, we can have several versions of the cache by different browser versions. But after a request, the cache will already be created. The server will check what image has to be served and if it exists, and then it'll deliver it if it's already there or generate it and deliver it. You can also use a specific file type and cache your asset as Storyblok is always caching, although we do not generate the images every time, even with WebP autodetection.

Migrating from the previous version of the service

If you are still using the previous version of the image service and are happy with that, keep using it. Anyway, we strongly advise you to migrate to the new version because you can benefit from the automatic WebP support detection, which will let you deliver lighter images to the users of your platform.

Migrating to the new version is very simple because you just need to:

• change back the domain img2.storyblok.com to simply a.storyblok.com, which is the default domain for assets;

• add /m at the end of the URL;

• move the filters from the beginning of your path to the end;

• if you are also using a custom domain to serve the assets stored in Storyblok, you need to forward the accept header from your CloudFront distribution. You can check the updates to the Custom Assets' Domain doc to update your configuration.

Examples

The URL of your asset is https://a.storyblok.com/f/39898/3310x2192/e4ec08624e/demo-image.jpeg and you want to apply the filters /200x0/filters:format(png). The URL with the first version of the image service is:

https://img2.storyblok.com/200x0/filters:format(png)/f/39898/3310x2192/e4ec08624e/demo-image.jpeg

In the new version, after applying the three transformations from the list above, the URL will look like this:

https://a.storyblok.com/f/39898/3310x2192/e4ec08624e/demo-image.jpeg/m/200x0/filters:format(png)