Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): mention uses for unoptimized #73604

Merged
merged 3 commits into from
Dec 6, 2024
+6 −4
Merged

chore(docs): mention uses for unoptimized #73604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1683103
chore(docs): mention uses for `unoptimized`
styfle Dec 6, 2024
7f8956d
docs(image): merge sentence to one line
samcx Dec 6, 2024
290ec81
Merge branch 'canary' into styfle/docs-72140
samcx Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/01-app/03-api-reference/02-components/image.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,8 +412,9 @@ You can also [generate a solid color Data URL](https://png-pixel.com) to match t
unoptimized = {false} // {false} | {true}
```

When true, the source image will be served as-is instead of changing quality,
size, or format. Defaults to `false`.
When true, the source image will be served as-is from the `src` instead of changing quality, size, or format. Defaults to `false`.

This is useful for images that do not benefit from optimization such as small images (<1KB), vector images (SVG), or animated images (GIF).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The < caused a parser error. Fixing in https://app.graphite.dev/github/pr/vercel/next.js/73658/docs-Fix-image-component-API-reference-parsing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks!

That link didn't work for me but I found the PR here:


```js
import Image from 'next/image'
Expand Down
5 changes: 3 additions & 2 deletions docs/02-pages/03-api-reference/01-components/image-legacy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,9 @@ const Example = () => {

### unoptimized

When true, the source image will be served as-is instead of changing quality,
size, or format. Defaults to `false`.
When true, the source image will be served as-is from the `src` instead of changing quality, size, or format. Defaults to `false`.

This is useful for images that do not benefit from optimization such as small images (<1KB), vector images (SVG), or animated images (GIF).

```js
import Image from 'next/image'
Expand Down
Loading