Imgix

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 { imgixProvider } from '@desource/image/providers/imgix';

export const imageConfig = {
  provider: 'imgix',
  providers: {
    imgix: imgixProvider({
      "baseURL": "https://your-source.imgix.net"
    })
  }
} satisfies ImageConfig;

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

Image source

Use an asset path under the Imgix source. Keep provider configuration pointed at its delivery hostname.

/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="/photo.jpg"
  alt="Sample image" width={800} height={500}
  modifiers={{
  "format": "webp",
  "quality": 80,
  "fit": "cover"
}}
/>

Provider options

baseURL

The public image service URL, including any required account or asset path.

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

Width, height, format and quality map to w, h, fm and q. Supports auto, crop, pixelDensity, focalPointXPosition, focalPointYPosition, gaussianBlur, watermarkImageURL, textString and other mapped Imgix operations.

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

• Fit maps cover to crop, contain to fill, fill to scale, inside to max and outside to min.
• The adapter does not generate secure URL signatures. Signed sources need server-side URL generation compatible with your Imgix configuration.