Skip to main content

Image

Embeds an image within the interface and controls its presentation. Use to visually illustrate concepts, showcase products, or support user tasks and interactions.

Anchor to propertiesProperties

Anchor to accessibilityRole
accessibilityRole
"none" | "presentation" | "img"
Default: 'img'

Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.

Anchor to alt
alt
string
Default: `''`

An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an s-image, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the alt is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read considerations when writing alternative text to learn more.

Anchor to aspectRatio
aspectRatio
`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`
Default: '1/1'

The aspect ratio of the image.

The rendering of the image will depend on the inlineSize value:

  • inlineSize="fill": the aspect ratio will be respected and the image will take the necessary space.
  • inlineSize="auto": the image will not render until it has loaded and the aspect ratio will be ignored.

For example, if the value is set as 50 / 100, the getter returns 50 / 100. If the value is set as 0.5, the getter returns 0.5 / 1.

Anchor to border
border
Default: 'none' - equivalent to `none base auto`.

Set the border via the shorthand property.

This can be a size, optionally followed by a color, optionally followed by a style.

If the color is not specified, it will be base.

If the style is not specified, it will be auto.

Values can be overridden by borderWidth, borderStyle, and borderColor.

Anchor to borderColor
borderColor
"" |
Default: '' - meaning no override

Adjust the color of the border.

Anchor to borderRadius
borderRadius
<>
Default: 'none'

Adjust the radius of the border.

Anchor to borderStyle
borderStyle
"" | <>
Default: '' - meaning no override

Adjust the style of the border.

Anchor to borderWidth
borderWidth
"" | <"small" | "small-100" | "base" | "large" | "large-100" | "none">
Default: '' - meaning no override

Adjust the width of the border.

Anchor to inlineSize
inlineSize
"auto" | "fill"
Default: 'fill'

The displayed inline width of the image.

  • fill: the image will takes up 100% of the available inline size.
  • auto: the image will be displayed at its natural size.
Anchor to loading
loading
"eager" | "lazy"
Default: 'eager'

Determines the loading behavior of the image:

  • eager: Immediately loads the image, irrespective of its position within the visible viewport.
  • lazy: Delays loading the image until it approaches a specified distance from the viewport.
Anchor to objectFit
objectFit
"contain" | "cover"
Default: 'contain'

Determines how the content of the image is resized to fit its container. The image is positioned in the center of the container.

Anchor to sizes
sizes
string

A set of media conditions and their corresponding sizes.

Anchor to src
src
string

The image source (either a remote URL or a local file resource).

When the image is loading or no src is provided, a placeholder will be rendered.

Anchor to srcSet
srcSet
string

A set of image sources and their width or pixel density descriptors.

This overrides the src property.

Was this section helpful?

Anchor to eventsEvents

Learn more about registering events.

Anchor to error
error
OnErrorEventHandler
Anchor to load
load
<typeof tagName> | null
Was this section helpful?

Code

<s-image
src="https://cdn.shopify.com/static/images/polaris/image-wc_src.png"
alt="Four pixelated characters ready to build amazing Shopify apps"
aspectRatio="59/161"
inlineSize="auto"
/>

Anchor to useful-forUseful for

  • Adding illustrations and photos.
Was this section helpful?

Anchor to best-practicesBest practices

  • Use high-resolution images to ensure a professional and high-quality experience.
  • Use optimized images so your app loads as fast as possible.
  • Use images intentionally, these should add clarity and lead users to the next step.
Was this section helpful?

Anchor to examplesExamples

Component examples

Anchor to example-basic-usageBasic usage

Anchor to example-basic-usageBasic usage

Demonstrates the simplest implementation of an image component with a source and alt text.

Anchor to example-responsive-layout-with-aspect-ratioResponsive layout with aspect ratio

Shows how to create a responsive image with a fixed 16:9 aspect ratio, set to cover the container, and loaded lazily.

Anchor to example-responsive-images-with-srcsetResponsive images with srcset

Illustrates how to provide multiple image sources for different screen sizes and resolutions using srcSet and sizes attributes.

Anchor to example-with-border-stylingWith border styling

Demonstrates how to apply border styling to an image, including width, style, color, and radius, using border-related properties.

Anchor to example-decorative-imageDecorative image

Shows how to mark an image as decorative, which will make screen readers ignore the image by setting an empty alt text and presentation role.

Anchor to example-auto-sized-imageAuto-sized image

Demonstrates an image with auto-sizing, which allows the image to adjust its size based on its container's width.

Anchor to example-within-layout-componentsWithin layout components

Shows how to use images within a grid layout, creating a consistent grid of images with equal size, aspect ratio, and styling.

Was this section helpful?

Basic usage

<s-image src="https://cdn.shopify.com/static/sample-product/House-Plant1.png" alt="Product image" />