Configure theme properties

The properties of product images used on the storefront are stored in the view.xml configuration file. This topic provides all details about what properties are available and how to configure them.

The properties for the images displayed on the product pages are defined by the gallery widget options. The options of the widget can be configured in the theme view.xml as well. For more details, view the Gallery widget topic.

Configure image properties

The conventional location of view.xml for a theme is:

Copy
<theme_dir>/etc/view.xml
Copied to your clipboard
<theme_dir>/etc/view.xml

For example, here is the view.xml of the Blank theme: app/design/frontend/Magento/blank/etc/view.xml.

In view.xml, image properties are configured in the scope of <images module="Magento_Catalog"> element:

Copy
<media>
    <images module="Magento_Catalog">
    ...
    </images>
</media>
Copied to your clipboard
<media>
    <images module="Magento_Catalog">
    ...
    </images>
</media>

Image properties are configured for each image type defined by the id and type attributes of the <image> element:

Copy
<images module="Magento_Catalog">
   <image id="unique_image_id" type="image_type">
   ...
   </image>
</images>
Copied to your clipboard
<images module="Magento_Catalog">
   <image id="unique_image_id" type="image_type">
   ...
   </image>
</images>

The following table describes the attributes in detail:

The following picture illustrates how image roles for product images are specified in the Admin:

Image properties are defined by the corresponding elements, for example:

Copy
<images module="Magento_Catalog">
    <image id="unique_image_id" type="image">
        <width>100</width> <!-- Image width in px -->
        <height>100</height> <!-- Image height in px -->
    </image>
</images>
Copied to your clipboard
<images module="Magento_Catalog">
    <image id="unique_image_id" type="image">
        <width>100</width> <!-- Image width in px -->
        <height>100</height> <!-- Image height in px -->
    </image>
</images>

All image properties used in view.xml should be listed in the order shown here to prevent a "This element is not expected." frontend error. The following table contains the list of all properties which can be configured:

Resize catalog images

Generally, product images are cached while saving the product. However, the magento catalog:images:resize command enables you to resize all images for display on your storefront. Situations where this could be necessary might be:

• After you import products, which might have images of various sizes
• If images were resized or deleted manually from cache

Each image assigned to a product must be resized in accordance with image metadata defined in a module's view.xml configuration file. After resizing an image, its resized copy is stored in the cache (/pub/media/catalog/product/cache directory). The application serves storefront images from cache.

Command usage:

Copy
bin/magento catalog:images:resize
Copied to your clipboard
bin/magento catalog:images:resize

This command supports synchronous (default) and asynchronous modes. Asynchronous means that images will not be processed immediately on command execution. Using the queue functionality, these images will be scheduled for resizing and then processed in the background. To enable asynchronous mode, use the -a or --async option.

The message Product images resized successfully displays after the command has finished.

To speed up the job while in asynchronous mode, you may manually run several instances of a consumer with the command in each instance:

Copy
bin/magento queue:consumer:start media.storage.catalog.image.resize
Copied to your clipboard
bin/magento queue:consumer:start media.storage.catalog.image.resize

Configure variables

The variable properties vars are configured for each module individually, defined by module name.

Copy
<vars module="Magento_Catalog">
    <var name="breakpoints">
        <var name="mobile">
            <var name="conditions">
                <var name="max-width">767px</var>
            </var>
            ...
        </var>
    </var>
    ...
</vars>
Copied to your clipboard
<vars module="Magento_Catalog">
    <var name="breakpoints">
        <var name="mobile">
            <var name="conditions">
                <var name="max-width">767px</var>
            </var>
            ...
        </var>
    </var>
    ...
</vars>

Any block that extends AbstractBlock, can fetch variable values with the getVar method:

Copy
$block->getVar($name, $module = null)
Copied to your clipboard
$block->getVar($name, $module = null)

Check the following example on getting the breakpoints variable by the Gallery block:

Copy
/**
 * Return breakpoints options
 *
 * @return string
 */
public function getBreakpoints()
{
    return $this->jsonEncoder->encode($this->getVar('breakpoints'));
}
Copied to your clipboard
/**
 * Return breakpoints options
 *
 * @return string
 */
public function getBreakpoints()
{
    return $this->jsonEncoder->encode($this->getVar('breakpoints'));
}

Last updated 9/11/2023

Was this helpful?

Yes

No