Imager X 3.0 Docs

# About Imager X

Imager is a Craft plugin for doing image transforms, optimizations and manipulations. It does all the things that the built-in image transform functionality do – and so much more.

TIP

Imager X is the newest iteration of Imager - which has been the leading image manipulation plugin for Craft CMS since 2016. Throughout this documentation, the terms "Imager X" and "Imager" is used intermittently. Both refer to "Imager X", the X is just sometimes dropped to make the text easier to read.

# Features

  • The most efficient template syntax for doing a bunch of image transforms in one go.
    craft.imager.transformImage(myImage, [{ width: mySmallestSize }, { width: myBiggestSize }], { ratio: 16/9, fillTransforms: true }) | srcset
  • Transforms are completely file based, no database queries needed.
  • Transform Assets (local and cloud-based ones), local images, external images, or even the transformed images themselves.
  • Upload and serve transforms from Amazon S3 or Google Cloud Storage. Or, write your own storage interface to use whichever cloud service you want. PRO
  • Support for modern image formats like WebP, AVIF and JPEG XL.
  • Optimize your legacy format images with jpegoptim, jpegtran, mozjpeg, optipng, pngquant, gifsicle, TinyPNG, Imagemin or Kraken. Or, write your own optimizer interface for whichever post-optimization tool or service you want.
  • Auto generate transforms on Asset upload or when saving elements. PRO
  • Console commands for batch generating transforms. PRO
  • A nifty utility for batch generating transforms. PRO
  • GraphQL support. PRO
  • Offload all your transforms to Imgix (opens new window). Or, write your own transformer to use whichever method/service you'd like. PRO
  • Support for interlaced/progressive images.
  • Support for animated gifs.
  • Support for fallback images when Assets are missing, or completely replacing all images with a placeholder one (especially useful in development).
  • If you know the aspect ration you want, you don't have to calculate the extra height/width.
    { width: 800, ratio: 16/9 }
  • New letterbox resize mode.
    { width: 600, height: 600, mode: 'letterbox', letterbox: { color: '#000', opacity: 0 } }
  • New croponly mode. To crop, not resize.
    { width: 600, height: 600, mode: 'croponly', position: '20% 65%' }
  • New cropZoom parameter for when you want to get a little closer.
    { width: 600, height: 600, mode: 'crop', position: '20% 65%', cropZoom: 1.5 }
  • Basic image effects, including grayscale, negative, blur, sharpen, gamma and colorize.
    { effects: { sharpen: true, gamma: 1.4, colorize: '#ff9933' } }
  • Advanced image effects, including color blend, tint, clut, levels, sepia, contrast, modulate, normalize, contrast stretch, unsharp mask, posterize and many more (Imagick imagedriver only).
    { effects: { modulate: [100, 40, 100], colorBlend: ['rgb(255, 153, 51)', 0.5] } }
  • Your own choice of which resize filter to use. Speed vs. quality is up to you (Imagick imagedriver only).
  • Lots of placeholder options, even the brand new blurhash (opens new window) thingy.
  • Support for watermarks.
    { watermark: { image: logo, width: 80, height: 80, position: { right: 30, bottom: 30 }, opacity: 0.8, blendMode: 'multiply' } }
  • Get color information, dominant color and palette, from your images.
  • A bunch of color utilities for getting brightness, hue, lightness, percieved brightness, relative luminance, saturation, brightness difference, color difference and (puh!) contrast ratio.

# Editions and pricing

Imager X comes in two editions, Lite ($49) and Pro ($99). Lite has all the base functionality for transforming and optimizing images, but to unlock the real power of Imager, you'll probably want Pro.

Features requiring Pro, has been tagged in the features list above.

# Support

Please post any support requests in the github repository (opens new window), and make sure to supply as much information about your issue as possible. Also refer to the trouble shooting section, and check the FAQ for common questions.

Installation →