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

Refactor identification of global states and properties #1833

Closed
wants to merge 4 commits into from

Conversation

adampage
Copy link
Member

@adampage adampage commented Oct 15, 2022

Closes #1823.

In reviewing the list of global states and properties, I found considerable overlap with the attributes already classified in the “6.6 Taxonomy...” section. As @JAWS-test reported, I discovered only 6 attributes that were missing from Taxonomy:

  • aria-braillelabel
  • aria-brailleroledescription
  • aria-current
  • aria-description
  • aria-keyshortcuts
  • aria-roledescription

In this commit, I’m proposing a refactor which:

  1. Adds the 6 missing states and properties to the Taxonomy section:

    • I put aria-braillelabel in the “Widget Attributes” category since its purpose is similar to aria-label, which had already been classified in that list.

    • I also put aria-keyshortcuts in the “Widget Attributes” category since it felt like it belongs there.

    • For now, I’ve put the remaining four in a new “Other Attributes” category since they didn’t appear to fit cleanly in any of the existing ones.

  2. Updates aria.js to identify all global attributes in the Taxonomy section with an annotation of “(Global)” or similar.

  3. Removes the “Global States & Properties” section, but incorporates its descriptive language into the Taxonomy section.

  4. Relocate the “Translatable Attributes” section so that the Taxonomy section may be more clearly understood as a complete collection of all ARIA attributes.


Preview | Diff

@adampage adampage added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Oct 15, 2022
@adampage adampage requested a review from jnurthen October 15, 2022 02:48
@adampage adampage self-assigned this Oct 15, 2022
@pkra pkra self-assigned this Oct 17, 2022
@pkra pkra self-requested a review October 17, 2022 07:30
Copy link
Member

@jnurthen jnurthen left a comment

Choose a reason for hiding this comment

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

This looks great with a few tweaks. Thanks so much!

index.html Show resolved Hide resolved
index.html Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@@ -203,6 +194,28 @@ function ariaAttributeReferences() {
node.replaceChild(l, parentNode);
}
}
// Annotate global attribute references
Copy link
Member

Choose a reason for hiding this comment

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

This file is maintained in aria-common - but having it here is great for now as it lets us test the changes.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, I see, thanks. Once this PR is finalized, would it be appropriate for me to create a separate PR for this file in the aria-common repo?

@adampage
Copy link
Member Author

Thanks very much, @jnurthen. I’ve committed those tweaks in e4b99e0.

@adampage adampage requested a review from jnurthen October 18, 2022 20:20
@spectranaut spectranaut requested review from JaninaSajka and Jaunita-George and removed request for JaninaSajka October 20, 2022 17:21
@adampage
Copy link
Member Author

Hi @cyns , you mentioned a related issue in our weekly meeting today, but my brain was in scribing mode and I fear I missed the details. 😅 I searched our open issue list for “taxonomy” and “parent” but didn’t find anything that seemed applicable. Could I trouble you to help me track that down?

@pkra pkra added this to the ARIA 1.3 milestone Jun 28, 2023
@pkra
Copy link
Member

pkra commented Nov 6, 2023

@adampage @jnurthen this had fallen off my radar. What needs to be done here?

@pkra
Copy link
Member

pkra commented Feb 7, 2024

Closing this as outdated -- this needs to wait until aria.js is refactored (in aria-common).

@pkra pkra closed this Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aria-current is missing in "6.6 Taxonomy of WAI-ARIA States and Properties"
3 participants