Skip to content

chore(docs): add example for densities prop usage #1937

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore(docs): add example for densities prop usage #1937

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1737dea
chore(docs): add example for densities prop usage
Afshar07 Aug 29, 2025
04490fa
Merge branch 'main' into docs/clarify-densities-usage
Afshar07 Sep 15, 2025
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
23 changes: 15 additions & 8 deletions docs/content/2.usage/1.nuxt-img.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,23 +134,30 @@ By default Nuxt generates *responsive-first* sizing.

### `densities`

To generate special versions of images for screens with increased pixel density.
The `densities` prop serves high-resolution images for Retina/HiDPI screens.

Nuxt Image generates multiple versions at different pixel densities and creates the appropriate `srcset`.

When you specify densities, Nuxt Image multiplies your base dimensions by each density value to generate the corresponding image sizes.

**Example:**

```vue
<NuxtImg
src="/logos/nuxt.png"
<!-- Small icon, sharp on all screen densities -->
<NuxtImg
src="/nuxt.png"
height="50"
densities="x1 x2"
/>

<!--
```
Will result in:
```html
<!-- Rendered HTML -->
<img
src="/_ipx/w_50/logos/nuxt.png"
srcset="/_ipx/w_100/logos/nuxt.png x2"
src="/_ipx/w_50/nuxt.png"
srcset="/_ipx/w_50/nuxt.png 1x,
/_ipx/w_100/nuxt.png 2x"
/>
-->
```

### `placeholder`
Expand Down
Loading