Caisy

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

export const imageConfig = {
  provider: 'caisy',
  providers: {
    caisy: caisyProvider()
  }
} satisfies ImageConfig;

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

Image source

Use a complete Caisy asset URL, without existing transformation parameters.

https://assets.caisy.io/assets/project-id/asset-id/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://assets.caisy.io/assets/project-id/asset-id/photo.jpg"
  alt="Sample image" width={800} height={500}
  modifiers={{
  "quality": 80
}}
/>

Provider options

This provider needs no service-specific factory options. Register the factory with no arguments.

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 and quality map to w, h and q. Other service parameters are serialized by name into the query.

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

• The adapter appends a new transformation query to src. Start with a clean source URL to avoid duplicate question marks.