8000 Docs: The Getting Started docs about local images using the `<Image>` component are wrong · Issue #80023 · vercel/next.js · GitHub
[go: up one dir, main page]

Skip to content
Docs: The Getting Started docs about local images using the <Image> component are wrong #80023
@ChristianIvicevic

Description

@ChristianIvicevic

What is the documentation issue?

In a fairly recent change in #78769 the docs were updated claiming that images from the public directory don't require explicit sizes:

return (
<Image
src="/profile.png"
alt="Picture of the author"
// width={500} automatically provided
// height={500} automatically provided
// blurDataURL="data:..." automatically provided
// placeholder="blur" // Optional blur-up while loading
/>
)

That information is, at the time of writing this, wrong and this behavior was never supported. It's possible this is part of an upcoming feature change in 15.4+, but right now it appears in the documentation of the current 15.3 version and is misleading new users.

Is there any context that might help us understand?

n/a

Does the docs page already exist? Please link to it.

https://nextjs.org/docs/app/getting-started/images#local-images

Metadata

Metadata

Assignees

Labels

DepthDocumentation issue which refers to a need for a deeper explanation, or precisionlocked

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0