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

ci: move accessible name to title, desc to desc #419

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

hidde
Copy link
Member

@hidde hidde commented Dec 30, 2024

Dit PR zet in de anatomy SVG's de toegankelijke naam in een <title> element en de toegankelijke omschrijving in een <desc> element.

Beide hebben een ID zodat we met een web component progressief kunnen verbeteren door aria-labelledby/aria-describedby toe te voegen voor meer compatibiliteit.


Dit zouden we zo kunnen gebruiken:

<svg-setup-name-description>
  <svg-render-svg src="anatomy.svg"></svg-render-svg>
</svg-setup-name-description>

(zie codepen voor werkend voorbeeld)

Waarbij als de anatomy.svg een <title> en <desc> bevatten met elk een id, die met aria-labelledby en aria-describedby aan elkaar worden gekoppeld.

Iets dat dan in een later stadium, bij betere AT support voor <title> en <desc>, kan worden gesimplificeerd naar:

<svg-render-svg src="anatomy.svg"></svg-render-svg>

Copy link

vercel bot commented Dec 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
candidate ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 10:49am
candidate-storybook-test ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 10:49am
evil-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 10:49am

@codecov-commenter
Copy link

codecov-commenter commented Dec 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (385fc70) to head (7305b9b).
Report is 21 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #419   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines          329       391   +62     
  Branches        26        34    +8     
=========================================
+ Hits           329       391   +62     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>
Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>
Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>
@hidde
Copy link
Member Author

hidde commented Jan 7, 2025

@jeffreylauwers @Rozerinay nog ff terugkoppeling nav ons gesprek voor de vakantie; we hadden het toen over hoe we de namen van de anatomie SVG's zouden doen.

Ik beloofde toen dat ik het ook in documentatie zou aanpassen zodat jullie zouden weten wat je moest doen. Dat heb ik gedaan in de issue template voor 'Anatomie vastleggen' in dit PR / op deze plek: https://github.com/nl-design-system/candidate/pull/419/files#diff-42fc50bbe5b4197e43ac58b211d1ab17bfe0b2aa5697119ba53402881762586b

Als deze opzet gekozen wordt / PR gemerged wordt, dan dan staat de documentatie er als je een nieuw 'Anatomie vastleggen' issue maakt voor nieuwe componenten die naar Candidate gaan. Zo niet, dan zal het na de nieuwe keuze gedocumenteerd moeten worden.

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 this pull request may close these issues.

2 participants