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

Improve documentation about "no JavaScript" scenarios #437

Open
ppvg opened this issue Dec 6, 2023 · 0 comments
Open

Improve documentation about "no JavaScript" scenarios #437

ppvg opened this issue Dec 6, 2023 · 0 comments
Labels
Collapsible Component 'Collapsible menu' documentation Documentation improvements or additions Helper classes Component 'Helper classes' javascript Pull requests that update Javascript code
Milestone

Comments

@ppvg
Copy link
Member

ppvg commented Dec 6, 2023

From independent accessibility report, SC 4.1.2:

Het volgende is niet fout in de component, maar wel in de voorbeeldcode: Op pagina components/accordion.html staat een component met uitklapbare elementen. Hiervoor worden knoppen gebruikt. In de componenten hebben deze op de juiste manier een aria-controls en een aria-expanded-attribuut gekregen. In de voorbeeldcode is dit echter niet gedaan, waardoor dit mogelijk fout zal worden overgenomen. In de voorbeeldcode wordt de waarde (in- of uitgeklapt) en het feit dat het een uitklapbaar element is nu niet aangegeven.

Ook de voorbeeldcode op pagina components/collapsible.html klopt niet, hier staan helemaal geen button-elementen in, waardoor er waarschijnlijk verschillende toegankelijkheidsproblemen optreden als deze code gebruikt wordt.

TL;DR: the example markup in the docs seems to be missing certain attributes and elements.

In reality, those are intentionally left out, so the components are usable and accessible when JavaScript is not available. Attributes and elements that are only needed for interactivity are added via JS. "Expandable" components start out expanded and are only collapsed if and when JS is working.

I.e.: "Works without JavaScript".

It might be good explicitly describe this in the docs, and perhaps even add some component examples that are rendered with JavaScript artificially "disabled".

@ppvg ppvg added the documentation Documentation improvements or additions label Dec 6, 2023
@HeleenSG HeleenSG added the javascript Pull requests that update Javascript code label Sep 19, 2024
@reinschaap reinschaap added Collapsible Component 'Collapsible menu' Helper classes Component 'Helper classes' labels Sep 26, 2024
@Davidemeer Davidemeer added this to the Fase 2 Manon milestone Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Collapsible Component 'Collapsible menu' documentation Documentation improvements or additions Helper classes Component 'Helper classes' javascript Pull requests that update Javascript code
Projects
None yet
Development

No branches or pull requests

4 participants