Support product media

• The media attribute of the product object
• Media filters

Product media is usually displayed on the product page. However, you might want to display product media in other areas of your theme, so it's recommended to build your media display in a snippet so that it can be reused.

To display product media, you can loop through the media attribute of the product object and apply the associated media filter, depending on the media type.

If you want to output product media on the product page, and your product page content is hosted in a product.liquid section, then you might do the following:

• Create a snippet called media.liquid to host your media display.
• Render media.liquid in your product.liquid section.

Each media type in the example above is wrapped in a <div> element with custom style and data attributes. These are based on the considerations documented in UX considerations, and should be adjusted accordingly to match your approach.

Every theme requires a different approach to create responsive media that works across all screen sizes and devices. The following general recommendations can help ensure that you're offering a good customer experience:

• Make media elements responsive
• Preserve media element interactivity

A product can have multiple videos, so if your theme has a thumbnail view for each media element, or displays multiple media elements at once, you should ensure that only the active video is playing.

Shopify-hosted 3D models use Google’s model viewer component, and externally rendered videos are rendered in <iframe> elements. Neither of these are responsive containers by default.

Shopify-hosted videos are rendered in HTML5 video players, which are responsive by default, however only once they’re rendered.

Given the above, you should consider using an aspect ratio box to create a responsive container for each.

Shopify-hosted, and externally-hosted, video elements, and 3D models have interactive components. For example, videos have progress bars and volume control, and 3D models can be rotated.

If any of these media elements are hosted in a carousel or swipe-interactive display, then the interactive components shouldn’t interfere with the ability to interact with the display.

Every media type has a preview_image attribute. This could be useful in scenarios like the following:

• Product thumbnails
• Social media images

If your theme displays thumbnails for each media source on the product, then you can utilize the preview_image attribute of the media object in order to show a thumbnail image for each media source.

For example:

Rather than only showing images for social media previews, you can include media preview images as well.

For example:

If merchants have 3D models of their products, then you can give them the option to showcase those models through AR. To do this, you can use the Shopify-XR library to support AR Quick Look in iOS’s Safari, and Android’s Scene Viewer.

You need to do the following to use this library:

• Initialize the library
• Launch the display

The following JavaScript needs to be included on product pages to initialize the library:

You can launch the display in two ways:

• With a button
• With JavaScript

You can launch the display with a button that has the following attributes:

You would include a button for each model type media source.

For example:

Rather than include a button to launch the display, you can use JavaScript. For example:

Shopify hosted videos can have all HTML5 video attributes set when they’re rendered with the Liquid video_tag or media_tag filter. For example:

• autoplay - Whether to automatically play the video after it’s loaded.
• loop - Whether to loop the video.
• muted - Whether to mute the video’s audio.
• controls - Whether a user can control the video playback.

Each parameter is false by default, however you can set them to be true like the following: