Imgix

Use Imgix with Craft

Installation #

To install Imgix, follow these steps:

  1. Download & unzip the file and place the imgix directory into your craft/plugins directory
  2. Install plugin in the Craft Control Panel under Settings > Plugins
  3. The plugin folder should be named imgix for Craft to see it.

Imgix works on Craft 2.4.x and Craft 2.5.x.

Configuring Imgix #

Copy config.php into Crafts config folder and rename it to imgix.php.

Then map your Asset Source handle to your Imgix domain, according to the example.

This plugin will lookup the Asset image's source handle, and figure out which Imgix domain to use. If a URL string is passed, it will use the first domain in the config file.

To purge images automatically on deletion/save or manually, you have to add your API key to the config file.

Using Imgix #

Check all their supported transform options in the Imgix documentation.

{% set transforms = [
    {
        width: 400,
        height: 300
    },
    {
        width: 940,
        height: 520
    },
    {
        width: 1400,
    },
] %}

{% set firstImage = craft.imgix.transformImage( asset, { width: 400, height: 350 }) %}
{% set secondImage = craft.imgix.transformImage( asset, transforms) %}

{# Image tag #}
{{ firstImage.img() }}

{# Get url for the first image #}
{{ firstImage.getUrl() }}

{# Image tag w/ srcset + tag attributes #}
{{ secondImage.srcset({ width: 700 }) }}

{# See transformed results #}
{{ dump(secondImage.transformed) }}

To use with Element API, you can call the service directly:

<?php
namespace Craft;

return [
    'endpoints' => [
        'news.json' => [
            'elementType' => ElementType::Entry,
            'criteria' => ['section' => 'news'],
            'transformer' => function(EntryModel $entry) {
                $asset = $entry->featuredImage->first();
                $featuredImage = craft()->imgix->transformImage( $asset, [ 'width' => 400, 'height' => 350 ]);
                return [
                    'title' => $entry->title,
                    'url' => $entry->url,
                    'jsonUrl' => UrlHelper::getUrl("news/{$entry->id}.json"),
                    'summary' => $entry->summary,
                    'featuredImage' => $featuredImage->getUrl(),
                ];
            },
        ],
    ]
];

Imgix Roadmap #

  • Clean it up
  • Add documentation
  • Look into improving srcset/API

Releases

1.0.6 — 2017-12-11 Download
  • Added: Added composer support
1.0.5 — 2017-11-29
  • Added: Added automatic and manual purging of images
  • Fixed: Fixed error when passing no attributes to srcset()
1.0.4 — 2017-11-20 Download
  • Added: Added lazyload attribute
  • Fixed: Fixed default options parameter
1.0.3 — 2017-09-21 Download
  • Added: Added support for ratio to transforms
1.0.2 — 2017-08-15 Download
  • Improved: Added getUrl() method
  • Improved: Added Element API example to docs
1.0.1 — 2017-08-10 Download
  • Improved: Added support for Focus Point
1.0.0 — 2017-04-03 Download
  • Added: Initial release

Currently available for Craft consulting and custom plugin development

Contact me