rsnext/errors/sharp-version-avif.md
Steven cc1f3b8a38
Add support for AVIF to next/image (#29683)
Add support for AVIF to `next/image`

- Fixes #27882 
- Closes #27432 

## Feature

- [x] Implements an existing feature request
- [x] Related issues linked
- [x] Integration tests added
- [x] Documentation added
- [x] Update manifest output
- [x] Warn when `sharp` is outdated
- [x] Errors & Warnings have helpful link attached
- [ ] Remove `image-size` in favor of `squoosh`/`sharp` (optional, need to benchmark)
2021-10-11 23:17:47 +00:00

1.4 KiB

Sharp Version Does Not Support AVIF

Why This Error Occurred

The next/image component's default loader uses sharp if its installed.

You are seeing this error because you have an outdated version of sharp installed that does not support the AVIF image format.

AVIF support was added to 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 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.