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 note to aria-roledescription #1666

Merged
merged 2 commits into from
Apr 29, 2022
Merged

add note to aria-roledescription #1666

merged 2 commits into from
Apr 29, 2022

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Dec 21, 2021

closes #1651

adds a note indicating that aria-roledescription may not be conveyed depending on the element/AT defaults or user settings.


Preview | Diff

closes #1651

adds a note indicating that `aria-roledescription` may not be conveyed depending on the element/AT defaults or user settings.
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@spectranaut spectranaut left a comment

Choose a reason for hiding this comment

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

Just one question! :)

<ol>
<li>The element to which <code>aria-roledescription</code> is applied has a valid <abbr title="Accessible Rich Internet Applications">WAI-ARIA</abbr> role or has an implicit WAI-ARIA role semantic.</li>
<li>The value of <code>aria-roledescription</code> is not empty or does not contain only whitespace characters.</li>
</ol>
<p class="note">Depending on the assistive technology, user verbosity settings, or other factors, certain elements' role descriptions might not be conveyed. If specifying <code>aria-roledescription</code> on such elements, then the custom role descriptions may also not be conveyed by these assistive technologies.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure, but should the first sentence be: "certain elements' role might not be conveyed" instead of "certain elements' role description might not be conveyed"?

When a AT does communicate the role like "link", we say the "role" is being communicated not the "role description" is being communicated, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

I was trying to use similar language per James's comment in the original issue](#1651 (comment)). specifically "At low verbosity, most role descriptions (custom or otherwise) should not be spoken at all"

That said, i'm honestly open to either wording. whatever people think is most appropriate

Copy link
Contributor

Choose a reason for hiding this comment

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

I see! then I'm agnostic too -- so long as @jnurthen thinks it the correct term.

Copy link
Member

Choose a reason for hiding this comment

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

"role description" is used in https://w3c.github.io/aria/#terms

When the button receives focus, assistive technologies may concatenate the platform's role description with the accessible name. For example, a screen reader may speak "push-button OK" or "OK button". The order of concatenation and specifics of the role description (e.g., "button", "push-button", "clickable button") are determined by platform accessibility APIs or assistive technologies.

So I think this is good to go.

@pkra pkra added this to the ARIA 1.3 milestone Jan 12, 2022
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.

I think this comes across well. 👍

@scottaohara
Copy link
Member Author

@jnurthen anything else you'd like to see here, or this ok to merge?

@pkra pkra merged commit 9cb71e9 into main Apr 29, 2022
@pkra pkra deleted the scottaohara-1651 branch April 29, 2022 14:25
github-actions bot added a commit that referenced this pull request Apr 29, 2022
SHA: 9cb71e9
Reason: push, by @pkra

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
pkra pushed a commit that referenced this pull request Jul 14, 2022
adds a note indicating that `aria-roledescription` may not be conveyed depending on the element/AT defaults or user settings.

closes #1651
jnurthen pushed a commit that referenced this pull request Oct 10, 2023
adds a note indicating that `aria-roledescription` may not be conveyed depending on the element/AT defaults or user settings.

closes #1651
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.

Question should aria-roledescription be prohibited on additional roles?
6 participants