@crystallize/react-image

React Srcset Images for Crystallize

A React package to output an img tag with different source variations from Crystallize using srcset. Use this to easily build responsive images powered by the Crystallize headless commerce service.

And don't forget: react image sizes attribute for fast ecommerce.

Demo

Demo

Install

yarn add @crystallize/react-image

Use

import { Image } from '@crystallize/react-image';

const imageFromCrystallize = {
    url: '...',
    variants: [...]
}

<Image
    {...imageFromCrystallize}
    sizes="(max-width: 700px) 90vw, 700px"
/>

Render child function

const imageFromCrystallize = {
    url: '...',
    variants: [...],
    altText: ''
}

<Image
    {...imageFromCrystallize}
    sizes="(max-width: 700px) 90vw, 700px"
>
  {({ src, srcSet, srcSetWebp, sizes, originalFileExtension, ...rest }) => {
      // Roll your own render
      return (
          <picture>
            {srcSetAvif.length > 0 && (
                <source
                    srcSet={srcSetAvif.join(", ")}
                    src={webp[0].url}
                    type="image/avif"
                    sizes={sizes}
                />
            )}
            {srcSetWebp.length > 0 && (
                <source
                    srcSet={srcSetWebp.join(", ")}
                    src={webp[0].url}
                    type="image/webp"
                    sizes={sizes}
                />
            )}
            {srcSet.length > 0 && (
                <source
                    srcSet={srcSet.join(", ")}
                    src={std[0].url}
                    type={`image/${originalFileExtension}`}
                    sizes={sizes}
                />
            )}

            <img src={src} sizes={sizes} {...rest} />
        </picture>
      )
  }}
</Image>