ImageKit

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

export const imageConfig = {
  provider: 'imagekit',
  providers: {
    imagekit: imagekitProvider({
      "baseURL": "https://ik.imagekit.io/your-id"
    })
  }
} satisfies ImageConfig;

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

Image source

Use a path within the ImageKit endpoint, including any configured origin folder.

/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={{
  "quality": 80,
  "format": "webp",
  "focus": "auto"
}}
/>

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, f and q in the tr query. Supports focus, cropMode, aspectRatio, radius, border, rotate, blur, named, progressive, lossless and dpr.

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 maintain_ratio, contain to pad_resize, fill to force, inside to at_max and outside to at_least.
• Use raw for an already composed ImageKit transformation string. This adapter does not generate URL signatures.