Jump to content

Image Placeholders


d'Hinnisdaël
 Share

Recommended Posts

Generate image placeholders for smoother lazyloading. Currently supports ThumbHashBlurHash, and average color placeholders.

I've been using the wonderful ImageBlurhash module for this in the past, but unfortunately it's no longer in active development. This new module adds ThumbHash and Average Color placeholder algorithms, improves performance by caching generated placeholders, fixes an issue when replacing images, and allows regenerating and clearing placeholders via the admin interface.

Try it out using the installation instructions below or check out the GitHub repo for details.

image.thumb.png.cf29518ee1fba172d90462e3d9e53553.png

 

Why use image placeholders?

Low-Quality Image Placeholders (LQIP) are used to improve the perceived performance of sites by displaying a small, low-quality version of an image while the high-quality version is being loaded. The LQIP technique is often used in combination with progressive lazyloading.

How it works

This module will automatically generate a small blurry image placeholder for each image that is uploaded to fields configured to use them. In your frontend templates, you can access the image placeholder as a data URI string to display while the high-quality image is loading. See below for markup examples.

Placeholder types

The module supports generating various types of image placeholders. The recommended type is ThumbHash which encodes most detail and supports transparent images.

  • ThumbHash is a newer image placeholder algorithm with improved color rendering and support for transparency.
  • BlurHash is the original placeholder algorithm, developed at Wolt. It currently has no support for alpha channels and will render transparency in black.
  • Average color calculates the average color of the image.


Installation

Install the module using composer from the root of your ProcessWire installation.

composer require daun/processwire-image-placeholders

Open the admin panel of your site and navigate to ModulesSiteImagePlaceholders to finish installation.
 

Configuration

You'll need to configure your image fields to generate image placeholders.

Setup → Fields → [images] → Details → Image placeholders

There, you can choose the type of placeholder to generate. If you're installing the module on an existing site, you can also choose to batch-generate placeholders for any existing images.

image.thumb.png.fc20d595668d5d230bdfe6c55aec479f.png


Usage

Accessing an image's lqip property will return a data URI string of its placeholder.

$page->image->lqip; // data:image/png;base64,R0lGODlhEAAQAMQAA

Accessing it as a method allows setting a custom width and/or height of the placeholder.

$page->image->lqip(300, 200); // 300x200px


Markup

Using a lazyloading library like lazysizes or vanilla-lazyload, you can show a placeholder image by using its data URI as src of the image.

<!-- Using the placeholder as src while lazyloading the image -->
<img
  src="<?= $page->image->lqip ?>"
  data-src="<?= $page->image->url ?>"
  data-lazyload
/>

Another technique is rendering the placeholder and the original image as separate images on top of each other. This allows smoother animations between the blurry unloaded and the final loaded state.

<!-- Display placeholder and image on top of each other -->
<div class="ratio-box">
  <img src="<?= $page->image->lqip ?>" aria-hidden="true">
  <img data-src="<?= $page->image->url ?>" data-lazyload>
</div>
  • Like 12
  • Thanks 7
Link to comment
Share on other sites

  • 2 weeks later...
  • 1 month later...
  • 8 months later...
  • 3 weeks later...

@FireWire Thanks for the heads-up! So you're saying it's currently working but will break in a future version of ProcessWire? Is there a specific release that triggers the issue on your end?

The module should probably also reset the output formatting state to the value it was before setting it to false, just in case.

Link to comment
Share on other sites

@d'Hinnisdaël I was testing the dev branch when it happened, but it also happened on main release after switching between the two. I was running code on non-image fields when it saw the output formatting error called out by a WireException. I wish I could be more specific on that. I guess for the sake of good practice AFAIK turning output formatting off when setting field values via the API is the right approach.

Also, thank you for your work on this module, it's really useful and a great implementation!

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...