Netlify

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

export const imageConfig = {
  provider: 'netlify',
  providers: {
    netlify: netlifyProvider({
      "path": "/.netlify/images"
    })
  }
} satisfies ImageConfig;

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

Image source

Use a local deployment path or a remote URL allowed in the Netlify configuration.

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

Provider options

path

The Image CDN endpoint; baseURL takes precedence.

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 the same width, height, quality, format, fit and position modifiers as netlifyImageCdn.

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

• netlify is an alias for netlifyImageCdn. Auto-detection selects netlifyImageCdn explicitly.
• For deployment configuration and remote origin examples, see the Netlify Image CDN guide. Large Media has its own provider.