rsnext/errors/sharp-version-avif.md

25 lines
1.4 KiB
Markdown
Raw Normal View History

# Sharp Version Does Not Support AVIF
#### Why This Error Occurred
The `next/image` component's default loader uses [`sharp`](https://www.npmjs.com/package/sharp) if its installed.
You are seeing this error because you have an outdated version of [`sharp`](https://www.npmjs.com/package/sharp) installed that does not support the AVIF image format.
AVIF support was added to [`sharp`](https://www.npmjs.com/package/sharp) in version 0.27.0 (December 2020) so your installed version is likely older.
#### Possible Ways to Fix It
- Install the latest version of `sharp` by running `yarn add sharp@latest` in your project directory
- If you're using the `NEXT_SHARP_PATH` environment variable, then update the `sharp` install referenced in that path, for example `cd "$NEXT_SHARP_PATH/../" && yarn add sharp@latest`
- If you cannot upgrade `sharp`, you can instead disable AVIF by configuring [`formats`](https://nextjs.org/docs/api-reference/next/image#image-formats) in your `next.config.js`
After choosing an option above, reboot the server by running either `next dev` or `next start` for development or production respectively.
> Note: This is not necessary for Vercel deployments, since `sharp` is installed automatically for you.
### Useful Links
- [Image Optimization Documentation](https://nextjs.org/docs/basic-features/image-optimization)
- [`next/image` Documentation](https://nextjs.org/docs/api-reference/next/image)