docs
  1. Support And Resources
  2. Upgrade Guides
  3. Migrate To Scayle Image Provider

Migrate to SCAYLE image provider

Requirements

To use @scayle/nuxt-image-provider, ensure you meet the following requirements:

  • Nuxt: Version 3 or later.
  • @nuxt/image: Installed and configured as a module in your Nuxt project.

Install SCAYLE Image Provider

yarn add @scayle/nuxt-image-provider

Update Nuxt Configuration

export default defineNuxtConfig({
  modules: [
    '@scayle/nuxt-image-provider'
  ],
  image: {
    providers: {
      scayle: {
        name: 'scayle',
        provider: '@scayle/nuxt-image-provider',
      },
    },
  },
})

The remaining legacy provider in the SFB under ~/providers/scayle can be removed.

Update components

All NuxtImg and NuxtPicture compents with the scayle provider should be change as follows.

NuxtImg to ScayleImg

<ScayleImg src="/images/sample.jpg" :width="300" brightness="1" should-trim />

NuxtPicture to ScaylePicture

<ScaylePicture src="/images/sample.jpg" :sizes="sizes" />
Provide Feedback