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

docs: Toevoegen tekstalternatief voor svg onder Anatomie #1794

Open
MarjonBakker opened this issue Dec 9, 2024 · 7 comments · Fixed by nl-design-system/candidate#361
Open
Assignees

Comments

@MarjonBakker
Copy link
Contributor

MarjonBakker commented Dec 9, 2024

Er is nog geen goed tekstalternatief voor de figure en de svg.

Voorstel voor Code Block:

<figure class="component-anatomy" style="">
    <!-- ↓ Toevoegen role=img en tekstalternatief -->
    <svg role="img" aria-label="Een vierkant met een lichtgrijze achtergrond, aangeduid met het cijfer 1. In het vierkant staat een stuk HTML ter illustratie, aangeduid met het cijfer 2"></svg>
    <figcaption>
        <!-- ↓ Meer uitleg voor een betere toegankelijke naam voor de figure -->
        Code Block, onderdelen:
        <ol class="utrecht-ordered-list utrecht-ordered-list--html-content">
            <li>Code Block</li>
            <li>Code</li>
        </ol>
    </figcaption>
</figure>

Op basis hiervan kunnen ook tekstalternatieven toegevoegd worden voor de overige componenten.

Er is een PR (#341), maar zie ook discussie op Slack.

Robbert pushed a commit to nl-design-system/candidate that referenced this issue Dec 9, 2024
Zie nl-design-system/documentatie#1794

Voegt toe aan de sectie Anatomie:

- `role="img"`
- `aria-label`
- in sommige gevallen meer context voor de toegankelijke naam van de
`figure`

---------

Co-authored-by: Hidde de Vries <[email protected]>
@hidde
Copy link
Member

hidde commented Dec 11, 2024

Textalternatieven voor de overgebleven candidate component anatomieën zitten in nl-design-system/candidate#361

@MarjonBakker
Copy link
Contributor Author

MarjonBakker commented Dec 12, 2024

Het gebruik van de aanhalingstekens in het aria-label pakt niet goed uit. Bijvoorbeeld bij Link:

aria-label="Een stuk lopende tekst, waarvan de laatste twee woorden blauw zijn en onderstreept. Dat deel is aangeduid met het cijfer 1. De tekst: \u201CDit is een voorbeeld van de link component\u201D."

NVDA leest \u201C en \u201D letterlijk zo voor, zowel in Chrome als in Firefox.

Graag kijken wat hier misgaat en dan nalopen bij alle anatomieën.

@MarjonBakker MarjonBakker reopened this Dec 12, 2024
@MarjonBakker
Copy link
Contributor Author

MarjonBakker commented Dec 12, 2024

@hidde, ik heb het hier nog over gehad met @rianrietveld en zij vond de tekst in het aria-label te lang. Haar voorstel is om het zo aan te pakken:

<figure>
  <svg aria-label="samenstelling component">[…]</svg>
  <figcaption>
    Een stuk lopende tekst, waarvan de laatste twee woorden [...]
    Onderdelen:
    1. Link
  </figcaption>
<figure>

@MarjonBakker
Copy link
Contributor Author

Nog een mogelijke uitwerking:

https://codepen.io/marjonfg/pen/YPKpXKM/fa8bde2af9374cfc7b7290729a416dc9

Met:

  • <title> en voor de SVG-elementen 1. en 2.
  • summary/detail in de figcaption

Voordelen:

  • geen role=img en geen lang aria-label voor de SVG
  • gebruikmaken van de mogelijkheden van SVG om losse onderdelen een naam te geven
  • title voor de korte beschrijving, desc voor de lange beschrijving
  • in de figcaption uitklapbare onderdelen voor slechtzienden die geen screenreader gebruiken, en ook als fallback voor vreemde ondersteuning van SVG's door alle diverse browser-screenreadercombinaties

@hidde
Copy link
Member

hidde commented Dec 13, 2024

Wmb is wat er precies op de SVG staat een alternatieve tekst die te weinig waarde toevoegt voor wie de afbeelding kan zien. Eens dat die tekst wat lang is als label.

Mijn voorstel zou zijn:

  • SVG met role=img en aria label "samenstelling component [naam]" en aria description "langere omschrijving van wat je precies ziet" (zoals huidige label)
    • dit kan dan technisch opgelost met aria-labelledby en aria-describedby van <title> en <desc> respectievelijk, zodat het beter wordt opgepikt door AT
    • dit neemt Rian's suggestie voor korter label mee, met haar aanvankelijke tekstsuggestie, en zorgt ook dat screenreadergebruikers bij de langere omschrijving kunnen komen
  • daaronder de figcaption zoals ie nu is, met uitleg per cijfer
    • zou dus blijven zoals het nu is
  • details/summary zoals in Marjons voorbeeld gebruiken voor toelichtingen bij het anatomie-onderdeel, als dat extra uitleg vereist, denk aan de picker knop bij een datepicker
    • mijn aanname is dat dit voor de huidige candidate componenten niet nodig zou zijn, omdat die toelichting daar nog bij geen component vereist is

@MarjonBakker
Copy link
Contributor Author

@hidde ik vind het prima, laat even weten wanneer ik iets kan zien?

@hidde
Copy link
Member

hidde commented Dec 27, 2024

Besproken met Jeff en Roos: met in het achterhoofd hoe de anatomiesectie bedacht is (eenvoudig de onderdelen aanwijzen), en de verwachting dat zo'n extra toelichting in veel gevallen niet op elk item staat (waardoor bij gebruik van een uitklapper soms wel, soms niet een uitklapchevron nodig zou zijn) kunnen de extra info / toelichtingen het beste volledig uitgeschreven worden en zichtbaar zijn.

Ik zorg daarom in #1851 dat de omschrijving evt over meerdere regels kan.

@MarjonBakker MarjonBakker self-assigned this Jan 7, 2025
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 a pull request may close this issue.

2 participants