Provider documentation
Gumlet
Generate transformations for a configured Gumlet image source.
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 { gumletProvider } from '@desource/image/providers/gumlet';
export const imageConfig = {
provider: 'gumlet',
providers: {
gumlet: gumletProvider({
"baseURL": "https://your-source.gumlet.io"
})
}
} satisfies ImageConfig; Registering this provider makes it the default for the configured components. To mix services, register each
provider and set provider="gumlet" on the image that should use this one.
Image source
Use an asset path served by the Gumlet source.
/photo.jpgUsage
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",
"fit": "cover"
}}
/>Provider options
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, fit, crop, auto, rotate, backgroundColor, focalPointXPosition, focalPointYPosition, pixelDensity and color adjustments.
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 crop, contain to fill, fill to scale, inside to max and outside to min.
- Use a clean source path: the adapter appends a transformation query.