docs: add preload example for NuxtImg

[divagueame]

Added example for passing an object to the preload prop to define fetch priority.

🔗 Linked issue

related to nuxt/nuxt.com#2061

❓ Type of change

• [X ] 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Document preload options.

From this other PR, I learned preload could take an object as a prop, but it's not documented on the site. This PR adds this information.

nuxt/nuxt#34341

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@nuxt/image@2124

commit: 43ce95b

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for the nuxt-img component's preload prop was updated to document an object form that can set fetchPriority on the preload link tag. The change adds an example (:preload="{ fetchPriority: 'high' }"), states that fetchPriority maps to the lowercase fetchpriority attribute, and lists accepted values (auto, high, low). No runtime behavior or exported/public API signatures were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description directly relates to the changeset by explaining that it documents the preload prop accepting an object to define fetch priority, references the related GitHub issue, and includes a link to the source PR that inspired the change.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title accurately describes the main change: adding a preload example to NuxtImg documentation, which matches the file update in docs/content/2.usage/1.nuxt-img.md.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 6.83%. Comparing base (07fd47d) to head (557ca6a).

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #2124   +/-   ##
=====================================
  Coverage   6.83%   6.83%           
=====================================
  Files         80      80           
  Lines       3729    3729           
  Branches     142     142           
=====================================
  Hits         255     255           
  Misses      3424    3424           
  Partials      50      50           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/2.usage/1.nuxt-img.md`:
- Line 371: Update the prose to use the camelCase key name "fetchPriority" to
match the JS object example for the preload prop (mentioning the preload prop
and the object key fetchPriority), and append a brief note listing the valid
values ("auto", "high", "low") so readers see the full set of options.
- Around line 371-375: Update the docs example and prose to state that the
preload.fetchPriority accepts three values—'auto', 'high', and 'low'—not just
'high', and update the example to show one or more of these values; also clarify
that the JS property is camelCase fetchPriority (as defined in BaseImageProps)
but becomes the lowercase HTML attribute fetchpriority on the generated preload
link (handled in NuxtImg component), so readers understand the mapping.