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

Image a11y sign off updates #351

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

Conversation

JoshBowdenConcepts
Copy link
Contributor

Summary

Updating the alt tags for the feature stories on Storybook to go above and beyond and be slightly more specific.

List of notable changes:

  • updated the alt tags for the feature stories on Storybook to go above and beyond and be slightly more specific.

Supporting resources (related issues, external links, etc):

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

@changeset-bot
Copy link

changeset-bot bot commented Jul 17, 2023

⚠️ No Changeset found

Latest commit: 39fb53a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jul 17, 2023

🟢 No design token changes found

@github-actions
Copy link
Contributor

github-actions bot commented Jul 17, 2023

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

artifacts section of workflow run

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences

@JoshBowdenConcepts JoshBowdenConcepts temporarily deployed to github-pages July 17, 2023 18:21 — with GitHub Actions Inactive
@@ -66,7 +78,7 @@ export const CustomClassWithAspectRatio: StoryFn<typeof Image> = () => (
<Image
src={placeholderImage}
className={style['custom-image']}
alt="placeholder, blank area with an off-white background color"
alt="placeholder, blank area with an off-white background color, custom aspect ratio"
Copy link
Collaborator

@rezrah rezrah Jul 31, 2023

Choose a reason for hiding this comment

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

Based on the feedback you received, we still issue with the stories with custom red outlines:

(sev 3) Within the Custom Class with Aspect Ratio and the Custom Class on Picture examples, the alt attribute has the same placeholder value of "placeholder, blank area with an off-white background color" although a red frame outlines the image.

although a red frame outlines the image.

Can we update the alt text to indicate there's a red outline here please?

Also FYI that the height and width attributes here are still 100%
Screenshot 2023-07-31 at 15 03 06.

This likely needs a code change under-the-hood for this component. How much effort is that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I discussed the 100% height and width with the a11y eng team and that is ok to keep in there for functionality. I will add the red outline to the description.

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.

None yet

2 participants