EdgeOne Pages

Provider documentation

EdgeOne Pages

Apply imageMogr2 transformations to files hosted on EdgeOne Pages.

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

export const imageConfig = {
  provider: 'edgeonePages',
  providers: {
    edgeonePages: edgeonePagesProvider({
      "baseURL": "https://your-project.edgeone.app"
    })
  }
} satisfies ImageConfig;

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

Image source

Use the path of an image deployed to EdgeOne Pages.

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

Provider options

baseURL
Required publicly accessible EdgeOne Pages domain.

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 and height map to thumbnail; fit supports contain, cover and fill. Supports quality, format, background, blur, crop, gravity, dx, dy, iradius, scrop, rotate, autoOrient, sharpen, strip, interlace and pad.

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

  • Missing baseURL throws an error. The image must exist on the configured Pages domain.
  • Crop offsets require a crop operation. Background padding is added when background is combined with dimensions.
← Back to all providers