Strapi plugin strapi-blurhash

A plugin for Strapi CMS that generates blurhash for your uploaded images.

Installation

To install, run:

npm install strapi-blurhash

Open/create file config/plugins.js. Enable this plugin by adding:

1module.exports = {
2    ...
3    'strapi-blurhash': {
4      enabled: true,
5      config: {
6        regenerateOnUpdate: true,
7        forceRegenerateOnUpdate: false,
8      }
9    },
10  }

Config explanations:

• If forceRegenerateOnUpdate is true, the plugin disregards whether the blurhash already exists and generates a new one.
• If regenerateOnUpdate is true (and forceRegenerateOnUpdate is false), the blurhash will only be generated if it is currently missing. This is a more conservative approach that avoids unnecessary processing but ensures blurhashes are eventually generated for all images.

Both of these values are going to be false if omitted.

How to generate blurhash for an image

In the Strapi Dashboard open Content Manager. Edit one collection/single type. Add or edit a Media field type and save the collection/single type.

How to get blurhash

Target a Strapi REST API endpoint. For example:

1localhost:1337/api/products?populate=Image.*

The response will be a JSON containing blurhash along with rest of the image data:

1{
2  "data": [
3    {
4      "id": 6,
5      "attributes": {
6        "name": "Test",
7        "createdAt": "2022-10-27T14:52:04.393Z",
8        "updatedAt": "2022-10-28T09:58:22.238Z",
9        "Image": {
10          "data": {
11            "id": 80,
12            "attributes": {
13              "name": "image.png",
14              "alternativeText": "image.png",
15              "caption": "image.png",
16              "width": 960,
17              "height": 168,
18              "formats": {
19                ...
20              },
21              "hash": "image_ed1fbcdba0",
22              "ext": ".png",
23              "mime": "image/png",
24              "size": 4.63,
25              "url": "/uploads/image_ed1fbcdba0.png",
26              "previewUrl": null,
27              "provider": "local",
28              "provider_metadata": null,
29              "createdAt": "2022-10-28T09:42:02.471Z",
30              "updatedAt": "2022-10-28T09:42:02.471Z",
31              "blurhash": "U{Nd,T?bof?u_Nxuj[x[objZayoe_Mxuj[x["
32            }
33          }
34        }
35      }
36    }
37  ],
38  "meta": {
39    "pagination": {
40      "page": 1,
41      "pageSize": 25,
42      "pageCount": 1,
43      "total": 1
44    }
45  }
46}

Regenerating Existing Content

If you've recently installed this plugin and already have existing media content, you can easily update the blurhash for these items. Use the Regenerator plugin to efficiently handle this task:

• Regenerator Plugin

This additional plugin can automate the process.

Links

npm blurhash package

github blurhash source

Changelog

All notable changes to this project will be documented in this section.

1.2.1

Changed

• now using sharp instead of canvas due to issues with .webp images.

1.2.2

Added

• forceRegenerateOnUpdate configuration option to force the regeneration of blurhash on every update, regardless of the existing blurhash.

1.2.3

Fixed

• fixed a bug with the image url

1.2.4

Fixed

• fixed a bug with the image url var

1.2.5

Changed

• updated the readme file

1.2.6

Changed

• updated tags

1.2.7

Fixed

• fixed forceRegenerateOnUpdate defaults

Changed

• added additional explanation to readme

1.3.0

Changed

• removed sharp dependency