accessibility

[ShaunSHamilton]

Would admonish be interested in improving the accessibility of the generated HTML and CSS?

• [ ] details elements are missing indication they are clickable (e.g. details:hover { cursor: pointer; })
• [ ] Admonish blocks should contain sr-only titles for blocks without titles
• [ ] Block titles should be included in aria-labels, and/or use semantic elements (e.g. header maybe)

[tommilligan]

Yes, very open to improving this.

Could you add a link to a reference for these attributes/general overview on the requirements? I don't have a lot of accessibility experience.

[ShaunSHamilton]

Relevant links:

• Role attribute
  • Specifically, the banner, note, and maybe complementary roles
• aria- attributes
  • Specifically, the aria-label attribute, but the aria-expanded might be relevant
• Interactive elements

If you do not like those docs, then Mozilla's are probably also more than enough: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles

Other than that, it would take some research on my part as to what a note/warning/quote/bug/example should indicate. Whether they should all have the same structure, or be specific to the directive. 🤷‍♂️

I do not have much a11y experience either. The top mentioned things are just what I want in a project I am writing.