Shopify

Setup

Install the framework package and the core package for the provider import:

npm install @desource/image @desource/image-svelte

Save this as image.config.ts beside your example component. Replace sample domains and identifiers with your own.

import type { ImageConfig } from '@desource/image';
import { shopifyProvider } from '@desource/image/providers/shopify';

export const imageConfig = {
  provider: 'shopify',
  providers: {
    shopify: shopifyProvider({
      "baseURL": ""
    })
  }
} satisfies ImageConfig;

Registering this provider makes it the default for the configured components. To mix services, register each provider and set provider="shopify" on the image that should use this one.

Image source

Use the image URL from the Storefront API; its existing query parameters are preserved.

https://cdn.shopify.com/s/files/1/0000/0001/files/photo.jpg

Usage

The example uses the shared configuration above and the Svelte image component.

<script lang="ts">
  import { Image, setImageConfig } from '@desource/image-svelte';
  import { imageConfig } from './image.config';

  setImageConfig(imageConfig);
</script>

<Image
  src="https://cdn.shopify.com/s/files/1/0000/0001/files/photo.jpg"
  alt="Sample image" width={800} height={500}
  modifiers={{
  "format": "webp",
  "crop": "center"
}}
/>

Provider options

baseURL

Optional CDN prefix for relative paths. Absolute Storefront image URLs can be used directly.

Pass shared defaults such as screens, domains, aliases and presets to the image configuration. Pass provider-specific defaults as modifiers in the provider factory.

Modifiers

Supports width, height, format, quality, padColor, crop, cropLeft, cropTop, cropWidth and cropHeight. Use crop: region with region coordinates.

Set dimensions on the component and pass service-specific operations through modifiers, as shown above. See the provider source for exact mappings and the service documentation for accepted values.

Provider notes

• Use Shopify crop values center, top, bottom, left, right or region.
• Use padColor for a padding color. Transformation availability is determined by Shopify CDN.