Skip to content
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.

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

Add "alt" attributes to generated HTML icon img elements #507

Merged
merged 4 commits into from
Apr 12, 2024

Conversation

dijitali
Copy link
Contributor

@dijitali dijitali commented Mar 27, 2024

Fixes

Description

Adds a null alt element to img elements in generated HTML in order to improve accessibility.

Tests

See reproduction steps in #505

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Copy link

netlify bot commented Mar 27, 2024

Deploy Preview for creativecommons-chooser ready!

Name Link
🔨 Latest commit 8f0b337
🔍 Latest deploy log https://app.netlify.com/sites/creativecommons-chooser/deploys/66194749fb6511000900d8b0
😎 Deploy Preview https://deploy-preview-507--creativecommons-chooser.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dijitali
Copy link
Contributor Author

dijitali commented Mar 27, 2024

Not sure how the code below is used and if it also needs the same change? Adding the alt attribute here didn't seem to have any noticeable result when running the project 🤷

<img
v-for="(icon, index) in [...iconsArr]"
:key="index"
:width="size"
:height="size"
:src="require(`@creativecommons/cc-assets/icons/cc-${filename(icon)}`)"
/>

@dijitali dijitali marked this pull request as ready for review March 27, 2024 03:20
@dijitali dijitali requested review from a team as code owners March 27, 2024 03:20
@dijitali dijitali requested review from TimidRobot, annatuma and zackkrida and removed request for a team March 27, 2024 03:20
@dijitali dijitali changed the title [WIP] add "alt" attributes to generated HTML icon img elements Add "alt" attributes to generated HTML icon img elements Mar 27, 2024
@possumbilities possumbilities requested review from possumbilities and removed request for a team, TimidRobot, annatuma and zackkrida March 28, 2024 20:09
@possumbilities
Copy link
Contributor

@dijitali are you still hoping to wrap this?

@dijitali
Copy link
Contributor Author

dijitali commented Apr 5, 2024

@possumbilities - should be all set now - have removed the prettier autoformatting changes.

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

I resolved the conflicts for you. Please see the requested change:

src/utils/license-utilities.js Show resolved Hide resolved
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

good work! thank you!

@TimidRobot TimidRobot merged commit 5dd9c45 into creativecommons:main Apr 12, 2024
4 checks passed
@TimidRobot TimidRobot self-assigned this Apr 12, 2024
@dijitali dijitali deleted the a11y/add-icon-img-alt branch April 14, 2024 23:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Generated HTML img elements have no "alt" attribute for accessibility
3 participants