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

Remove AXRoleDescription fields #14

Closed
wants to merge 8 commits into from
Closed

Remove AXRoleDescription fields #14

wants to merge 8 commits into from

Conversation

mattgarrish
Copy link
Member

@mattgarrish mattgarrish commented Oct 20, 2022

This pull request matches the DPUB AAM with the core by removing the AXRoleDescription fields and replacing them with a note about generating them.

@cookiecrook @avneeshsingh @clapierre @gregoriopellegrino I know you guys discussed the role announcement issue at TPAC. Could you confirm that this change does not impact those discussions and the possible resolution?

Fixes #11


Preview | Diff

@clapierre
Copy link

Matt I don't see the note about generating the descriptions. Maybe I missed it?

@mattgarrish
Copy link
Member Author

Maybe I missed it?

No, looks like it got swapped out with note 2, which doesn't apply to this document, when I did a merge of the main branch to make sure everything was up to date. It's the same note as here: https://w3c.github.io/core-aam/#ftn.note1

I'll get that updated shortly. I just noticed that the core spec also now links to the note. I'll see if I can find the code to do that, too. (I originally started this change last spring and then put it on hold while the other discussions were going on.)

@clapierre
Copy link

Looks great now Matt, thanks.

@cookiecrook cookiecrook self-requested a review October 20, 2022 17:16
Comment on lines -886 to +830
<td>AXRole: <code>AXLink</code><br /> AXSubrole: <code>&lt;nil&gt;</code><br />
AXRoleDescription: <code>'link'</code>
</td>
<td>AXRole: <code>AXLink</code><br /> AXSubrole: <code>&lt;nil&gt;</code></td>
Copy link
Contributor

@cookiecrook cookiecrook Oct 20, 2022

Choose a reason for hiding this comment

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

We had agreed at TPAC to keep the link role descriptions, among others. Still investigating a way to add additional clarifiers, but this PR should probably be moved back to Draft until the corresponding ARIA issue is settled. w3c/aria#1643

Copy link
Contributor

Choose a reason for hiding this comment

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

One of the proposals discussed was to expose the applied aria role through the API... Similar to how the DOM id is exposed.

@cookiecrook
Copy link
Contributor

Current thought is that all existing AX API attributes would be retained, but a few new ones would be added, such as the raw string value of the role attribute, and where needed, some additional bikesheded property that contained the other user-presentable info, "bibliography reference"

@mattgarrish
Copy link
Member Author

Current thought is that all existing AX API attributes would be retained, but a few new ones would be added

Okay, in that case I'll close off this PR and issue #11.

Do you guys have a sense of how long it will take to find a solution to the announcement issue? We've been sitting on the 1.1 update for a few years now and it has some critical fixes like deprecating the list roles. If it's not a complicated fix, we can keep waiting, but if it's going to take some time to implement a solution would it make sense to move this to a 1.2 release?

@cookiecrook
Copy link
Contributor

cookiecrook commented Oct 25, 2022

Still in discussion with the API owners, but thinking it will likely use AXCustomContent.

@mattgarrish mattgarrish deleted the fix/issue-11 branch January 8, 2024 15:56
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.

AXAPI descriptions reference superclass role names
3 participants