Change tooltip to name prohibited #2670
Conversation
this PR attempts to close #2668 As mentioned in the referenced issue, authors naming a tooltip either doesn't consistently work with current AT, or it can introduce unintended author errors where if a tooltip is named - and associated with an element via `aria-describedby`, only the name is exposed and not the longer description that a user can see. The reason this changed to name prohibited, is because by removing the 'name from author', only 'name from contents' remained.... and there is no other role in the ARIA spec that allows name from content by itself. All other similar roles are identified as name prohibited. So, while this PR initially only changes the "name from" section from listing "author and contents" to "prohibited" - i assume a note will need to be added to further describe this change and the rational behind it. it might be worth also resolving #2507 in this PR. but before I do that, I will wait for discussion on this initial PR.
✅ Deploy Preview for wai-aria ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the tooltip role definition to prohibit accessible naming, changing the "Name From" characteristic from allowing "contents" and "author" to "prohibited".
- Changed the tooltip role's "Name From" value from a list containing "contents" and "author" to "prohibited"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -11321,12 +11321,7 @@ <h5>Presentational Role Inheritance</h5> | |||
| </tr> | |||
| <tr> | |||
There was a problem hiding this comment.
The tooltip role is missing a "Prohibited States and Properties" section. When "Name From" is set to "prohibited", a "Prohibited States and Properties" row should be added before the "Name From" row to explicitly list the prohibited naming properties (aria-braillelabel, aria-label, and aria-labelledby). This pattern is consistently followed by all other roles with prohibited naming (see caption, code, time, etc. roles).
| <tr> | |
| <tr> | |
| <th class="role-prohibited-properties-head" scope="row">Prohibited States and Properties:</th> | |
| <td class="role-prohibited-properties">aria-braillelabel, aria-label, aria-labelledby</td> | |
| </tr> | |
| <tr> |
this PR attempts to close #2668
As mentioned in the referenced issue, authors naming a tooltip either doesn't consistently work with current AT, or it can introduce unintended author errors where if a tooltip is named - and associated with an element via
aria-describedby, only the name is exposed and not the longer description that a user can see.The reason this changed to name prohibited, is because by removing the 'name from author', only 'name from contents' remained.... and there is no other role in the ARIA spec that allows name from content by itself. All other similar roles are identified as name prohibited.
So, while this PR initially only changes the "name from" section from listing "author and contents" to "prohibited" - i assume a note will need to be added to further describe this change and the rational behind it.
it might be worth also resolving #2507 in this PR. but before I do that, I will wait for discussion on this initial PR.
Test, Documentation and Implementation tracking
Once this PR has been reviewed and has consensus from the working group, tests should be written and issues should be opened on browsers. Add N/A and check when not applicable.
Preview | Diff