Skip to content

Commit f8494b4

Browse files
authored
chore(docs): mention uses for unoptimized (#73604)
Add docs for `unoptimized` use cases. - Closes #72140
1 parent 2461539 commit f8494b4

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/01-app/03-api-reference/02-components/image.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,9 @@ You can also [generate a solid color Data URL](https://png-pixel.com) to match t
412412
unoptimized = {false} // {false} | {true}
413413
```
414414

415-
When true, the source image will be served as-is instead of changing quality,
416-
size, or format. Defaults to `false`.
415+
When true, the source image will be served as-is from the `src` instead of changing quality, size, or format. Defaults to `false`.
416+
417+
This is useful for images that do not benefit from optimization such as small images (<1KB), vector images (SVG), or animated images (GIF).
417418

418419
```js
419420
import Image from 'next/image'

docs/02-pages/03-api-reference/01-components/image-legacy.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,9 @@ const Example = () => {
313313

314314
### unoptimized
315315

316-
When true, the source image will be served as-is instead of changing quality,
317-
size, or format. Defaults to `false`.
316+
When true, the source image will be served as-is from the `src` instead of changing quality, size, or format. Defaults to `false`.
317+
318+
This is useful for images that do not benefit from optimization such as small images (<1KB), vector images (SVG), or animated images (GIF).
318319

319320
```js
320321
import Image from 'next/image'

0 commit comments

Comments
 (0)