Installation

Add @nuxt/image devDependency to your project:

yarn add --dev @nuxt/image

npm install -D @nuxt/image

Add the module to buildModules in your nuxt.config:

export default {  target: 'static',  buildModules: [    '@nuxt/image',  ]}

If you use server target (default) and are using the default provider, add @nuxt/image to modules section instead:

export default {  modules: [    '@nuxt/image',  ]}

Configuration

Add an image section in your nuxt.config.js:

export default {  image: {    // Options  }}

See module options for available options.

TypeScript

If you're using Typescript, add the types to your "types" array in tsconfig.json after the @nuxt/types (Nuxt 2.9.0+) or @nuxt/vue-app entry.

{  "compilerOptions": {    "types": ["@nuxt/types", "@nuxt/image"]  }}

Upgrading

Troubleshooting

If an error occurs during installation:

• Ensure using LTS version of NodeJS or latest update of 12.x, 14.x or 16.x (NodeJS Downloads page)
• Try to upgrade to latest versions:

yarn upgrade @nuxt/image

npm up @nuxt/image

• Try recreating lock-file:

rm yarn.lock && yarn

rm package-lock.json && npm i

• If there is still an error related to sharp and node-gyp, it is is probably becase your OS architecture or NodeJS version is not included in pre-built binaries and needs to built from source (for example, this sometimes occurs on Apple M1). Checkout node-gyp for install requirements.
• If none of the above worked, please open an issue and include error trace, OS, Node version and the package manager used for installing.