inspiredminds/contao-image-alternatives

Contao extension to provide the possibility of defining alternative images to be used on different output devices.

1.2.4 2023-06-16 09:02 UTC

Requires

• php: >=7.1
• contao/core-bundle: ^4.9
• symfony/config: ^4.4 || ^5.1
• symfony/dependency-injection: ^4.4 || ^5.1
• symfony/http-foundation: ^4.4 || ^5.1
• symfony/http-kernel: ^4.4 || ^5.1
• symfony/translation: ^4.4 || ^5.1
• webmozart/path-util: ^2.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16 || ^3.0

LGPL-3.0-or-later

• Fritz Michael Gschwantner

README

Contao Image Alternatives

This extensions expands the capabilities of using responsive images with art direction in Contao. You will have the possibility to define a set of alternatives which will then allow you to define the respective alternatives per image in the file manager.

Suppose you want to use different images for a certain image size depending on the output device, i.e. a specific image for desktop, for tablets and for mobile. You can define a set of alternatives called mobile and tablet for example (desktop will be the fallback - the original image):

# config/config.yaml
contao_image_alternatives:
    alternatives:
        - tablet
        - mobile

Now you can choose the alternatives for each image separately in Contao's file manager:

The back end labels for each alternative can be translated via the image_alternatives translation domain:

# translations/image_alternatives.en.yaml
tablet: Tablet
mobile: Mobile

Within your image size settings you can then choose per media query item, whether an alternative image should be chosen for this particular image size:

Alternatively you can also set the alternative in your config via contao_image_alternatives.sizes.*.items. Note that the name of the size must be same name as in contao.image.sizes and the media query for each item must match with the ones in contao.image.sizes.*.items:

# config/config.yaml
contao_image_alternatives:
    alternatives:
        - tablet
        - mobile
    sizes:
        example:
            items:
                -
                    media: '(max-width: 480px)'
                    alternative: mobile
                -
                    media: '(max-width: 800px)'
                    alternative: tablet

When you choose the configured image size in your content element or module, the generated images will automatically use the alternative versions for each source image for the particular image size media query item.

Alternative Important Parts

It is also possible to set different important parts for each image alternative. When editing an image in the file manager, there will be a an Important part alternative selection at the top, with which you can switch between the different important parts. For example if you have set the default important part for an image, plus the important part for the mobile alternative, then latter will be used for your mobile media query image size item (if configured) and otherwise the default. This allows you to crop the image to different parts for different output devices within the same image.

Pre-Crop

It is also possible to to pre-crop the image to the important part before the image is resized according to the resize settings. This allows you to crop the image to the important part for certain image sizes while otherwise only resizing to a specific width or height. This setting can be set per image size in the database and also via the bundle configuration:

# config/config.yaml
contao_image_alternatives:
    sizes:
        example:
            pre_crop: true