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

Form guidelines: Labels #366

Closed
wants to merge 2 commits into from
Closed

Form guidelines: Labels #366

wants to merge 2 commits into from

Conversation

hidde
Copy link
Member

@hidde hidde commented Nov 8, 2023

Voorbeeld

Een paar keuzes/vragen:

  • Voor codevoorbeelden: in huidige richtlijnen gebruiken we React componenten om voorbeelden en code te renderen, maar als we de “partials” herbruikbaar willen maken is mijn voorstel geen React te gebruiken. Dat betekent dat we qua vormgeving minder kunnen doen.
  • Consistentie bij het schrijven van HTML elementen en attributen: ik neig naar “<label>-element” ipv “label element” of “label element”. Verder goed om attributen steeds in ```'s te zetten, zodat ze als code worden weergegeven.
  • Consistentie bij het schrijven van “Doen”/“Niet doen”, doen we na de : een hoofdletter of niet?
  • Waar we naar WCAG verwijzen, wil ik voorstellen dat zoveel mogelijk te doen in een positieve zin, nl “als je X doet, voldoe je aan x.x.x”. Daarnaast zou het altijd concreet moeten zijn, wat precies moet er goed gedaan worden?
  • Ik zou verticale spacing willen tussen ul en codevoorbeelden, wat is de netste plek om dit te doen?

Specifiek voor Rian:

  • ik heb nog paar kleine typoconsistentie-dingetjes aangepast.

Copy link

vercel bot commented Nov 8, 2023

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

Name Status Preview Comments Updated (UTC)
documentatie ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 8, 2023 8:29pm

@hidde hidde marked this pull request as draft November 8, 2023 10:07
@hidde hidde force-pushed the extend-form-guidelines branch from e8ec42d to 5f46190 Compare November 8, 2023 14:56
@hidde hidde changed the title docs: Add label guidance Form guidelines: Labels Nov 8, 2023
@hidde hidde force-pushed the add-label-guidance branch from d97ab33 to cfe4168 Compare November 8, 2023 20:25
</select>
```

Het geven van een goede toegankelijke naam aan formuliervelden is verplicht volgens de volgende WCAG-succescriteria:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dit kan nog iets concreter (en verwijzen naar 22 docs want die hebben de nieuwste CSS (long story)), zie suggesties hieronder


Het geven van een goede toegankelijke naam aan formuliervelden is verplicht volgens de volgende WCAG-succescriteria:

- [2.4.6: Koppen en labels (niveau AA)](https://www.w3.org/WAI/WCAG21/Understanding/headings-and-labels)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [2.4.6: Koppen en labels (niveau AA)](https://www.w3.org/WAI/WCAG21/Understanding/headings-and-labels)
- [2.4.6: Koppen en labels (niveau AA)](https://www.w3.org/WAI/WCAG22/Understanding/headings-and-labels): zegt dat een label het onderwerp of doel moet beschrijven

Het geven van een goede toegankelijke naam aan formuliervelden is verplicht volgens de volgende WCAG-succescriteria:

- [2.4.6: Koppen en labels (niveau AA)](https://www.w3.org/WAI/WCAG21/Understanding/headings-and-labels)
- [3.3.2: Labels of instructies (niveau A)](https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [3.3.2: Labels of instructies (niveau A)](https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions)
- [3.3.2: Labels of instructies (niveau A)](https://www.w3.org/WAI/WCAG22/Understanding/labels-or-instructions): zegt dat formuliervelden een label of instructie moeten hebben (doel van die eis: gebruikers weten wat ze moeten invullen)


- [2.4.6: Koppen en labels (niveau AA)](https://www.w3.org/WAI/WCAG21/Understanding/headings-and-labels)
- [3.3.2: Labels of instructies (niveau A)](https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions)
- [4.1.2: Naam, rol, waarde (niveau A)](https://www.w3.org/WAI/WCAG21/Understanding/name-role-value.html)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [4.1.2: Naam, rol, waarde (niveau A)](https://www.w3.org/WAI/WCAG21/Understanding/name-role-value.html)
- [4.1.2: Naam, rol, waarde (niveau A)](https://www.w3.org/WAI/WCAG22/Understanding/name-role-value.html): zegt dat elementen (waaronder formuliervelden) een toegankelijke naam moeten hebben


De placeholder kan ook voor verwarring zorgen bij gebruikers. Is het al veld ingevuld? Zie het onderzoek [Placeholders in Form Fields Are Harmful](https://www.nngroup.com/articles/form-design-placeholders/) van de Nielsen Norman Group.

[to-do] Afbeelding (of in HTML)goed/slecht
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rianrietveld Hier staat nog een to do!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffreylauwers Kun jij hier een plaatje voor maken?
Iets als
Scherm­afbeelding 2023-11-09 om 07 58 56
Met als alt: Voorbeeld van twee sets formuliervelden voor email en telefoonnummer. De eerste alleen een placeholder als zichtbaar label (fout) en de tweede met een permanent label boven het invoerveld (goed).

@hidde hidde requested review from Robbert and rianrietveld November 8, 2023 20:38
@hidde hidde marked this pull request as ready for review November 8, 2023 20:40
- Het biedt voldoende ruimte voor labels van verschillende lengtes. Het kan zijn dat gebruikers vertaalsoftware gebruiken op de pagina, waardoor labels langer of korter kunnen zijn dan je verwacht.
- Dit werkt beter voor gebruikers die de tekst inzoomen.
- Het biedt een natuurlijke ‘scan-lijn’.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffreylauwers Kun je voor dit onderdeel "Zet het label boven het formulierveld" een afbeelding emaken, iets als:
Scherm­afbeelding 2023-11-13 om 12 22 26

Waarbij het duidelijk is dat het label onder het formulierveld plassten tot verwarring leidt.
Alt tekst: twee maal de weergave van verschillende adresvelden
een met de labels onder het formulierveld en een met de labels boven het formulierveld.

Copy link
Contributor

@rianrietveld rianrietveld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hidde @jeffreylauwers
Als Jeffrey nog twee plaatjes maakt (zie comments) is het wat mij betreft goed.

@rianrietveld
Copy link
Contributor

rianrietveld commented Nov 13, 2023

@hidde Bij links en diescption heb ik een kort introtekstje gedaan. Dat zou hier ook moeten.

"Een label vertelt wat er bij een formulierveld moet worden gekozen of ingevuld. Belangrijk is dat iedereen deze informatie meekrijgt."

En dan de rest van de tekst.

@hidde hidde changed the base branch from extend-form-guidelines to main November 20, 2023 16:12
@hidde
Copy link
Member Author

hidde commented Nov 20, 2023

Base aangepast naar main omdat we besloten hebben deze gelijk naar main te zetten, als extra pagina onder de huidige 'Formulieren' richtlijnen en met '(beta)' erachter, we verwijderen dan in de huidige richtlijnen de stukjes over labels / linken die naar deze nieuwe pagina.

@Yolijn Yolijn deleted the add-label-guidance branch November 22, 2024 07:57
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