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

Clarify description computation for aria-describedby #177

Merged
merged 8 commits into from
Jul 27, 2023

Conversation

adampage
Copy link
Member

@adampage adampage commented Dec 6, 2022

Closes #176.

Added editorial notes to 4.2 Description Computation.


Preview | Diff

@adampage adampage self-assigned this Dec 6, 2022
@JAWS-test
Copy link

I suspect your change is wrong and has nothing to do with what was discussed:

  • your change, if I understand correctly, prohibits me from referring to the own element via aria-describedby. This should not be forbidden and was not so far
  • It was discussed that aria-description doesn't matter when referring to the element with aria-description via aria-describedby. The AccName and not the AccDesc of the element referenced by aria-describedby does matter (because aria-labelledby and aria-describedby work the same).

@JAWS-test
Copy link

@adampage
Copy link
Member Author

adampage commented Dec 8, 2022

I understand now. 🤦🏻‍♂️ Thank you for setting me straight, @JAWS-test. This is particularly embarrassing because I scribed that Nov 10 meeting. My brain was apparently not in attendance.

Assuming that I do actually understand now 😅, it seems like this simple replacement of “Text content computation” with the more specific “Name computation would be sufficient?

@adampage adampage changed the title Add note to clarify lack of support for self-referencing with aria-describedby Clarify description computation for aria-describedby Dec 8, 2022
Copy link
Contributor

@cookiecrook cookiecrook left a comment

Choose a reason for hiding this comment

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

Would this also need to be changed in item 3 (Host language features) where the phrase "text equivalent computation" is used? It's not clear to me why this one would be specific to name comp, but the latter references T.E. comp.

@cookiecrook
Copy link
Contributor

(E.g. line 247, just below this diff boundary)

@MelSumner MelSumner requested a review from accdc February 27, 2023 21:06
Copy link
Contributor

@cookiecrook cookiecrook left a comment

Choose a reason for hiding this comment

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

I think the answer is yes, so I'm changing my response from "Comment" to "Request Changes."

@adampage
Copy link
Member Author

adampage commented Mar 1, 2023

I think the answer is yes, so I'm changing my response from "Comment" to "Request Changes."

Done. Thanks, @cookiecrook.

Copy link
Contributor

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

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

👍

@MelSumner MelSumner requested a review from cookiecrook March 2, 2023 18:18
index.html Outdated Show resolved Hide resolved
@accdc
Copy link
Contributor

accdc commented Apr 14, 2023

Hi, I've been rereading this issue and am confused because it seems to flip back and forth. Is the purpose to prevent self-referencing by aria-describedby but not for aria-labelledby?

I have seen this used successfully on tables that have checkbox or radio button controls that will reference the parent row using aria-describedby to announce the full content of the row being selected when the screen reader is interacting with it, and this is quite helpful.

Would this change prevent something like this from working?

@cookiecrook
Copy link
Contributor

@accdc wrote:

Hi, I've been rereading this issue and am confused because it seems to flip back and forth. Is the purpose to prevent self-referencing by aria-describedby but not for aria-labelledby?

I have seen this used successfully on tables that have checkbox or radio button controls that will reference the parent row using aria-describedby to announce the full content of the row being selected when the screen reader is interacting with it, and this is quite helpful.

Would this change prevent something like this from working?

If you're referring to the note @jnurthen and I were discussing in the thread, no, it won't prevent anything from working. It's just informative authoring guidance.

If "this change" is referring to something else, I would need a more specific reference.

adampage and others added 3 commits July 10, 2023 23:51
Co-authored-by: James Craig <cookiecrook@users.noreply.github.com>
@adampage
Copy link
Member Author

I’m inclined to limit this PR to clarifying that aria-describedby’s computation should only gather the accessible name(s) of the referenced node(s), not their accessible descriptions. I’m to blame for misinterpreting the original consensus to begin with. 😣 If we think there’s merit to discouraging a node from describing itself, how about tackling that as a separate issue?

In the meantime, I’ve committed your suggested reversion, @cookiecrook. I also created a quick Codepen to examine aria-labelledby, aria-label, aria-describedby, and aria-description, in case it could be helpful in follow-up discussions.

@adampage adampage requested a review from cookiecrook July 11, 2023 04:55
Copy link
Contributor

@cookiecrook cookiecrook left a comment

Choose a reason for hiding this comment

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

Seems okay to me

@adampage
Copy link
Member Author

Thanks very much, @cookiecrook. I believe this is ready for merge, @spectranaut / @jnurthen / @pkra?

@MelSumner MelSumner merged commit 881d960 into main Jul 27, 2023
github-actions bot added a commit that referenced this pull request Jul 27, 2023
SHA: 881d960
Reason: push, by MelSumner

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

Clarify: should aria-description be able to self-reference like aria-labelledby?
6 participants