Skip to content

Refactor identification of global states and properties - #1833

Closed
adampage wants to merge 4 commits into
w3c:mainfrom
adampage:refactor-global-attr-list
Closed

Refactor identification of global states and properties#1833
adampage wants to merge 4 commits into
w3c:mainfrom
adampage:refactor-global-attr-list

Conversation

@adampage

@adampage adampage commented Oct 15, 2022

Copy link
Copy Markdown
Member

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

@jnurthen jnurthen left a comment

Copy link
Copy Markdown
Member

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!

Comment thread index.html
Comment thread index.html
Comment thread index.html Outdated
Comment thread common/script/aria.js
node.replaceChild(l, parentNode);
}
}
// Annotate global attribute references

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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

pkra commented Nov 6, 2023

Copy link
Copy Markdown
Member

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

@pkra

pkra commented Feb 7, 2024

Copy link
Copy Markdown
Member

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