Prepr

Provider documentation

Prepr

Generate asset transformation paths for a Prepr project.

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

export const imageConfig = {
  provider: 'prepr',
  providers: {
    prepr: preprProvider({
      "projectName": "your-project"
    })
  }
} satisfies ImageConfig;

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

Image source

Use a path on the project asset stream.

/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": "jpeg",
  "fit": "cover"
}}
/>

Provider options

projectName
Required project name used in https://{projectName}.stream.prepr.io.

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

Maps width, height, quality, format and crop to Prepr path operations. Fit cover maps to crop, and jpeg becomes jpg.

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

  • A missing or blank projectName throws an error.
  • Only cover is mapped from the standard fit modes. Use Prepr-native modifiers for other supported operations.
← Back to all providers