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

WCAG Accessibility #14

Open
caseyg opened this issue Jun 13, 2022 · 2 comments
Open

WCAG Accessibility #14

caseyg opened this issue Jun 13, 2022 · 2 comments

Comments

@caseyg
Copy link

caseyg commented Jun 13, 2022

Thank you for the wonderful script! I've wanted to do something with telescopic text for ages, but it wasn't so easy to implement before this.

Is anybody up for collaborating on making this plugin WCAG accessible? I might need some help navigating the JS side but am happy to do any research/translation needed on the accessibility requirements and test things out.

From what I gather: the script currently renders a bunch of <span> elements for links instead of <a> with descriptive titles. I wonder if it could also be more semantic by rendering nested <ul> elements (mirroring the semantic meaningfulness of the editor syntax!), and then just using CSS to preserve "inline text" formatting.

Here's a WCAG checklist that I started to look through. Some of the key issues I found are:

  • Lack of keyboard navigation
  • Non-semantic elements, e.g. links are currently <span> instead <a>
    • Missing link descriptions (could say something like "expands so-and-so..."?)
@jackyzha0
Copy link
Owner

woah @caseyg yes, I would love to work on this! (cc: @spencerc99)

We initially tried implementing this with nested <detail> and <summary> tags but the styling wouldn't play nicely ://

Curious what would be intuitive keyboard navigation, I think just having each expansion be tab-selectable might make sense? (which, if we do an <a> should automatically happen)

@spencerc99
Copy link
Collaborator

spencerc99 commented Jun 13, 2022 via email

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