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

Update: account for common labeledby spelling variant for aria-labell… #2371

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Nov 8, 2024

Updates the existing note and adds new ua and author requirements for instances of aria-labelledby and aria-labeledby

Closes #2093

i did not put this content into the accounting for author errors section, because it just fit a lot better in the aria-labelledby section. so if that's not the way we want to go about this update, then i'd appreciate help in rewording / moving the content to that section, as i was just not finding the words/logical placement for it there.

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.

  • "author MUST" tests:
  • "user agent MUST" tests:
  • Browser implementations (link to issue or commit):
    • WebKit:
    • Gecko:
    • Blink:
  • Does this need AT implementations?
  • Related APG Issue/PR:
  • MDN Issue/PR:

Preview | Diff

…edby

Updates the existing note and adds new ua and author requirements for instances of aria-labelledby and aria-labeledby
Copy link

netlify bot commented Nov 8, 2024

Deploy Preview for wai-aria ready!

Name Link
🔨 Latest commit 3209da7
🔍 Latest deploy log https://app.netlify.com/sites/wai-aria/deploys/672e726c1cc39a0008dff115
😎 Deploy Preview https://deploy-preview-2371--wai-aria.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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.

This is clear. Thank you for providing this clarity.

@@ -11821,7 +11821,8 @@ <h2>Definitions of States and Properties (all aria-* attributes)</h2>
<p>If the interface is such that it is not possible to have a visible label on the screen, authors SHOULD use <pref>aria-label</pref> and SHOULD NOT use <pref>aria-labelledby</pref>. Authors MUST NOT specify <code>aria-labelledby</code> on an element which has an explicit or implicit WAI-ARIA role where <code>aria-labelledby</code> is <a href="#prohibitedattributes">prohibited</a>. As required by the <a href="#textalternativecomputation">accessible name and description computation</a>, user agents give precedence to <pref>aria-labelledby</pref> over <pref>aria-label</pref> when computing the accessible name property.</p>
<p>The <pref>aria-labelledby</pref> attribute is similar to <pref>aria-describedby</pref> in that both reference other elements to calculate a text alternative (an accessible name, and description, respectively). While a concise accessible name is preferable, a description can either be concise, or provide more verbose information.</p>
<!-- keep previous sentence synced with the associated description in #aria-describedby -->
<p class="note">The expected spelling of this property in <abbr title="United States">U.S.</abbr> English is "labeledby." However, the <a>accessibility <abbr title="Application Programing Interfaces">API</abbr></a> features to which this property is mapped have established the "labelledby" spelling. This property is spelled that way to match the convention and minimize the difficulty for developers.</p>
<p class="note">The expected spelling of this property in <abbr title="United States">U.S.</abbr> English is "labeledby." However, the <a>accessibility <abbr title="Application Programing Interfaces">API</abbr></a> features to which this property is mapped have established the "labelledby" spelling.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p class="note">The expected spelling of this property in <abbr title="United States">U.S.</abbr> English is "labeledby." However, the <a>accessibility <abbr title="Application Programing Interfaces">API</abbr></a> features to which this property is mapped have established the "labelledby" spelling.</p>
<p class="note">The expected spelling of this property in <abbr title="United States">U.S.</abbr> English is "labeled by." However, the <a>accessibility <abbr title="Application Programing Interfaces">API</abbr></a> feature this property was originally based on map had established the <abbr title="United Kingdom">U.K.</abbr> English spelling, "labelled by."</p>

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.

Document interop of misspelled aria-labeledby and its conflict resolution
4 participants