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

Deprecation of doc-endnote role #22

Closed
7studio opened this issue Nov 24, 2021 · 5 comments
Closed

Deprecation of doc-endnote role #22

7studio opened this issue Nov 24, 2021 · 5 comments

Comments

@7studio
Copy link

7studio commented Nov 24, 2021

Hi Kitty,

First, thank you for this component (and generally for all your works) which helped us build our own into aem env.

I would like your point of view concerning the deprecation of the doc-endnote role: https://www.w3.org/TR/dpub-aria-1.1/#doc-endnote and the recently change into Axe dequelabs/axe-core#2759

What is your recommandation about this change? Should we simply remove the role on <li> or change it for another one like doc-footnote?

Thank you for your time and your answer.

Xavier.

@KittyGiraudel
Copy link
Owner

Hello Xavier,

Thank you for reaching out and for the kind words. I wasn’t aware, so very nice of you to share this information! I guess as soon as Axe flags this as “not okay”, we should update the library’s markup to remove it. Until then, I guess it’s fine to keep it. :)

@AleksandrHovhannisyan
Copy link
Contributor

AleksandrHovhannisyan commented Jun 30, 2022

Just wanted to chime in here! Lighthouse unfortunately flags this as an accessibility issue, stating that [role] values are not valid. Not a big deal for my site since I only have on article with footnotes, but it's something to consider. One potential fix could be to extend the API to support custom role overrides for the list items, defaulting to the current role if not specified (although this opens up the potential for role abuse by users who don't know better). A simpler option may be to add a flag to allow users to opt out of the old roles.

@KittyGiraudel
Copy link
Owner

Shall we just remove that attribute? I’ll happily accept a PR and publish it. :)

@AleksandrHovhannisyan
Copy link
Contributor

AleksandrHovhannisyan commented Jun 30, 2022

@KittyGiraudel Sure! I can push up a PR.

Edit: Although I'm not sure: Do we want to remove just the doc-endnote role or all of the roles? 🤔

@KittyGiraudel
Copy link
Owner

Done in v0.11.0. Thank you! :)

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

No branches or pull requests

3 participants