Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs-#1020: add nuxt img alt prop definition #1628

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

Jump to bottom
Merged
merged 5 commits into from
Dec 20, 2024
Merged

docs-#1020: add nuxt img alt prop definition #1628

merged 5 commits into from
Dec 20, 2024

Conversation

@Baroshem
Copy link
Collaborator

🔗 Linked issue

Resolves #1020

❓ Type of change

  • 📖 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

This PR adds a note in the documentation about the alt prop that NuxtImg accepts while it is not documented.

@Baroshem Baroshem requested a review from danielroe as a code owner December 11, 2024 11:43
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 11, 2024 •
edited
Loading

Deploying nuxt-image with  Cloudflare Pages  Cloudflare Pages

Latest commit: a6404b6
Status: ✅  Deploy successful!
Preview URL: https://13b61b92.nuxt-image.pages.dev
Branch Preview URL: https://docs--1020.nuxt-image.pages.dev

View logs

@Baroshem Baroshem self-assigned this Dec 11, 2024
@codecov-commenter
Copy link

codecov-commenter commented Dec 11, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.87%. Comparing base (06f7f77) to head (a6404b6).
Report is 6 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1628      +/-   ##
==========================================
+ Coverage   62.83%   62.87%   +0.03%     
==========================================
  Files          79       79              
  Lines        3536     3539       +3     
  Branches      411      412       +1     
==========================================
+ Hits         2222     2225       +3     
  Misses       1285     1285              
  Partials       29       29

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

danielroe
danielroe reviewed Dec 20, 2024
View reviewed changes
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

<NuxtImg> accepts all the possible image props, including alt:

image/src/runtime/components/_base.ts

Lines 31 to 52 in 92a6eee

width: { type: [String, Number], required: false },
height: { type: [String, Number], required: false },
alt: { type: String, required: false },
referrerpolicy: { type: String as unknown as () => ImgHTMLAttributes['referrerpolicy'], required: false },
usemap: { type: String, required: false },
longdesc: { type: String, required: false },
ismap: { type: Boolean, required: false },
loading: {
type: String as () => 'lazy' | 'eager',
required: false,
validator: (val: any) => ['lazy', 'eager'].includes(val),
},
crossorigin: {
type: [Boolean, String] as unknown as () => 'anonymous' | 'use-credentials' | boolean,
required: false,
validator: (val: any) => ['anonymous', 'use-credentials', '', true, false].includes(val),
},
decoding: {
type: String as () => 'async' | 'auto' | 'sync',
required: false,
validator: (val: any) => ['async', 'auto', 'sync'].includes(val),
},

I think if we mention it here we should note that <NuxtImg> does not apply any special handling for alt but reiterate how important it is to provide it, and include a link to MDN.

@Baroshem
Copy link
Collaborator Author

Baroshem commented Dec 20, 2024 •
edited
Loading

Fixed @danielroe

Could you check if now it looks good? :)

Should I also write the importance of setting this attribute?

danielroe
danielroe reviewed Dec 20, 2024
View reviewed changes
@danielroe danielroe merged commit 362eca3 into main Dec 20, 2024
3 checks passed
@danielroe danielroe deleted the docs/#1020 branch December 20, 2024 11:10
@github-actions github-actions bot mentioned this pull request Dec 20, 2024
Closed
@github-actions github-actions bot mentioned this pull request Jan 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielroe danielroe danielroe approved these changes

Assignees

@Baroshem Baroshem

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add alt props into documentation

4 participants

@Baroshem @codecov-commenter @danielroe