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

chore(*): Add aria-describedby reference to error message element as … #12051

Merged
merged 9 commits into from
Sep 19, 2022

Conversation

MayaKirova
Copy link
Contributor

…well since readers are more likely to read it than aria-errormessage.

Note: Works with more advanced readers like NVDA. More basic ones like the built-in win Narrator don't seem to read it though.

Closes #12043

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

Checklist:

  • All relevant tags have been applied to this PR
  • This PR includes unit tests covering all the new code (test guidelines)
  • This PR includes API docs for newly added methods/properties (api docs guidelines)
  • This PR includes feature/README.MD updates for the feature docs
  • This PR includes general feature table updates in the root README.MD
  • This PR includes CHANGELOG.MD updates for newly added functionality
  • This PR contains breaking changes
  • This PR includes ng update migrations for the breaking changes (migrations guidelines)
  • This PR includes behavioral changes and the feature specification has been updated with them

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
coditva Utkarsh Maheshwari
…well since readers are more likely to read it than aria-errormessage.
@@ -472,6 +472,9 @@ export class IgxGridCellComponent implements OnInit, OnChanges, OnDestroy, CellT
/** @hidden @internal */
@HostBinding('attr.aria-describedby')
public get describeBy() {
Copy link
Member

Choose a reason for hiding this comment

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

PS: There's also a describedby in the row templates

…r. Also remove aria-errormessage since it's not supported.
@mddragnev mddragnev added ✅ status: verified Applies to PRs that have passed manual verification and removed ❌ status: awaiting-test PRs awaiting manual verification labels Sep 9, 2022
@mddragnev
Copy link
Member

mddragnev commented Sep 9, 2022

This does work with MacOS VoiceOver and NVDA.

@MayaKirova
Copy link
Contributor Author

@damyanpetev I think it reads better when there's no aria-describedby on the cell that point to the header (does not repeat the header twice in NVDA) but it might be a breaking change since there are some tests that explicitly expect the old describedby attribute. Should we remove it or just set both the error and the header ref for describedby?

@MayaKirova
Copy link
Contributor Author

@damyanpetev I think it reads better when there's no aria-describedby on the cell that point to the header (does not repeat the header twice in NVDA) but it might be a breaking change since there are some tests that explicitly expect the old describedby attribute. Should we remove it or just set both the error and the header ref for describedby?

Actually it also seem to depend on the browser and reader.

  • In NVDA (win)
    Chrome and Edge now read the header text 1 time, but Firefox does not read the header.

  • In VoiceOver (macOs)
    Chrome does not to read the header.

So I guess it's better to go with both so that there's no breaking change and the header is read at least once on every browser/reader.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
…r elem ref.
@MayaKirova MayaKirova added ❌ status: awaiting-test PRs awaiting manual verification and removed ✅ status: verified Applies to PRs that have passed manual verification labels Sep 9, 2022
@MayaKirova MayaKirova requested a review from dkamburov September 9, 2022 12:34
@mddragnev mddragnev added 💥 status: in-test PRs currently being tested and removed ❌ status: awaiting-test PRs awaiting manual verification labels Sep 12, 2022
@ChronosSF ChronosSF changed the base branch from master to 14.1.x September 12, 2022 15:38
@mddragnev mddragnev added ✅ status: verified Applies to PRs that have passed manual verification and removed 💥 status: in-test PRs currently being tested labels Sep 13, 2022
Copy link
Member

@damyanpetev damyanpetev left a comment

Choose a reason for hiding this comment

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

LGTM

@ChronosSF ChronosSF merged commit 42c3c39 into 14.1.x Sep 19, 2022
@ChronosSF ChronosSF deleted the mkirova/improve-validator-aria branch September 19, 2022 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Validation aria attributes are not read in screen readers.
6 participants