Image
The Image component renders an image for the Storefront API's
Image object.
Example code
Anchor link to section titled "Example code"
| Name | Type | Description |
|---|---|---|
| data | PartialDeep<ImageType> |
An object with fields that correspond to the Storefront API's Image object. |
| options? | ImageSizeOptions |
An object of image size options for Shopify CDN images. |
| src | string |
A URL string. This string can be an absolute path or a relative path depending on the loader. |
| width | number |
The integer value for the width of the image. This is a required prop when src is present. |
| height | height |
The integer value for the height of the image. This is a required prop when src is present. |
| loader? | (props: ImageLoaderOptions): string |
A custom function that generates the image URL. Parameters passed into this function includes src and an options object that contains the provided width, height and loaderOptions values. |
| loaderOptions? | ImageLoaderOptions['options'] |
An object of loader function options. For example, if the loader function requires a scale option, then the value can be a property of the loaderOptions object (for example, {scale: 2}). |
Component type
Anchor link to section titled "Component type"The Image component is a shared component, which means that it renders on both the server and the client. For more information about component types, refer to React Server Components.
Storefront API data
Anchor link to section titled "Storefront API data"The data prop is an object with fields that correspond to the Storefront API's Image object:
Image size options
Anchor link to section titled "Image size options"You can change the size and format of the image returned by the Shopify CDN.
| Key | Description |
|---|---|
width |
A string of the pixel width (for example, 100px) or original for the original width of the image. |
height |
A string of the pixel height (for example, 100px) or original for the original height of the image. |
crop |
Valid values: top, bottom, left, right, or center. |
scale |
Valid values: 2 or 3. |
format |
Valid values: jpg or pjpg. |