Filerobot

Provider documentation

Filerobot

Transform assets delivered by Scaleflex Filerobot.

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

export const imageConfig = {
  provider: 'filerobot',
  providers: {
    filerobot: filerobotProvider({
      "baseURL": "https://your-token.filerobot.com"
    })
  }
} satisfies ImageConfig;

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

Image source

Use a project-relative asset path or an absolute Filerobot delivery URL.

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

Provider options

baseURL
Your Filerobot project delivery URL; required for relative asset paths.

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 fit to func and quality to q, with width, height and Filerobot image transformation parameters passed through.

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

  • Absolute source URLs bypass baseURL. Start with an untransformed source URL because the adapter appends its own query.
← Back to all providers