Docs: Image Component Size Attribute Description

[columk1]

What is the documentation issue?

The docs are unclear on width and height attributes. The description says that the "intrinsic width" should be supplied and will be used to infer the aspect ratio of the image. It says that the size of the image is controlled by CSS. The issue is that if you supply the intrinsic values of a massive image and display it in a tiny container, the Image component will use the full image resolution with no transformations, apart from the quality value.

The width property represents the intrinsic image width in pixels. This property is used to infer the correct aspect ratio of the image and avoid layout shift during loading. It does not determine the rendered size of the image, which is controlled by CSS, similar to the width attribute in the HTML tag.

Required, except for statically imported images or images with the fill property.

Would it be more accurate to say that the width and height attributes represent the desired size of the optimized image and that the aspect ratio must match that of the original image?

Is there any context that might help us understand?

Example

If I supply width={100} and height={100} with the src of a 5000px x 5000px image and place it in a 100px x 100px container, the component will create two optimized versions of the image, one at 1x (100px x 100px) and one at 2x (200px x 200px). If I supply the intrinsic width and height as advised, I get a 100x100px container with a 5000px x 5000px image inside, with no other versions in the srcset.

Here's a reproduction:
https://codesandbox.io/p/devbox/dreamy-snowflake-gzhv63?workspaceId=ws_6kqiFEp5cJmwx5b444u6zo

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

https://nextjs.org/docs/pages/api-reference/components/image

[github-actions]

We could not detect a valid reproduction link. Make sure to follow the bug report template carefully.

Why was this issue closed?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router.

The bug template that you filled out has a section called "Link to the code that reproduces this issue", which is where you should provide the link to the reproduction.

• If you did not provide a link or the link you provided is not valid, we will close the issue.
• If you provide a link to a private repository, we will close the issue.
• If you provide a link to a repository but not in the correct section, we will close the issue.

What should I do?

Depending on the reason the issue was closed, you can do the following:

• If you did not provide a link, please open a new issue with a link to a reproduction.
• If you provided a link to a private repository, please open a new issue with a link to a public repository.
• If you provided a link to a repository but not in the correct section, please open a new issue with a link to a reproduction in the correct section.

In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue.

My repository is private and cannot make it public

In most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:

• Remove any code that is not related to the issue. (pages, API routes, components, etc.)
• Remove any dependencies that are not related to the issue.
• Remove any third-party service that would require us to sign up for an account to reproduce the issue.
• Remove any environment variables that are not related to the issue.
• Remove private packages that we do not have access to.
• If the issue is not related to a monorepo specifically, try to reproduce the issue without a complex monorepo setup

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue.

I think my reproduction is good enough, why aren't you looking into it quickly?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources

• How to Contribute to Open Source (Next.js)
• How to create a Minimal, Complete, and Verifiable example
• Reporting a Next.js bug
• Next.js Triaging issues