Ga naar hoofdinhoud

Candidate

In het kort

Een Community component kan naar Candidate als:

  • Meerdere organisaties het component hergebruiken in productie
  • Het kernteam ziet dat het breed inzetbaar is en potentie heeft voor standaardisatie
  • Er capaciteit is bij het kernteam voor het selecteren, documenteren, maken en testen van de component

Doelen van Candidate status

  • Teams kunnen met vertrouwen het component van NL Design System gebruiken
  • Gedeeld ownership tussen kernteam en meerdere andere teams
  • Voorstel zonder controversiële delen - verschillende ideeën uit de community zijn teruggebracht tot één gemene deler
  • Zichtbaarheid geven tijdens "request for comments" periode - essentiële aanvullingen en aanpassingen kunnen getest worden
  • Bruikbaar voor meeste huisstijlen in de publieke sector
  • Robuust maken - component kan in verschillende omgevingen ingezet worden
  • Best effort op toegankelijkheid - specialisten uit het kernteam hebben het gevalideerd

Wat betekent Candidate?

Dit component is een voorstel voor een Hall of Fame component. Het kernteam onderhoud t het en werkt met meerdere organisaties aan een versie die breed bruikbaar is. De component moet mogelijk nog extra goed getest en stabiel gemaakt worden.

Candidate componenten zijn bruikbaar maar kunnen nog wijzigen. Ze zijn geschikt voor nieuwe projecten, maar updates kunnen breaking changes bevatten.

Hoewel Candidate componenten al aan veel kwaliteitseisen voldoen, kan het kernteam nog niet garanderen dat API's stabiel blijven. Er kan ook onverhoopt een ander vergelijkbaar component voor in de plaats komen.

Wat heb je nodig voor Candidate?

👉 Volg het Candidate stappenplan

Hergebruik en consistentie

  • ✅ Ingezet door 2 of meer organisaties met verschillende huisstijlen
  • ✅ De NL Design System Figma bibliotheek komt overeen met de code-implementatie
  • ✅ Aliassen van alternatieve namen zijn vastgelegd in documentatie
  • ✅ Anatomie van de component is vastgelegd
  • ✅ Component is versimpeld of opgesplitst waar nodig

Technische kwaliteit

  • ✅ Geen organisatie-specifieke API's meer - alle API's zijn gebaseerd op gemeenschappelijke use cases
  • ✅ API volgt conventies en is geprefixed met 'nl'
  • ✅ Design tokens volgen conventies en zijn geprefixed met 'nl'
  • ✅ Hergebruik van logische common tokens is geïmplementeerd
  • ✅ Alle design tokens zijn algemeen nuttig voor thema's van publieke organisaties

Documentatie en beschikbaarheid

  • ✅ Beschikbaar in de NL Design System Storybook
  • ✅ Beschikbaar in de NL Design System Figma bibliotheek
  • ✅ Component heeft dezelfde documentatie op website en Storybook
  • ✅ Figma verwijst naar documentatie op de website
  • ✅ Storybook stories, Figma voorbeelden en unit tests hebben coverage van alle features
  • ✅ Verwijzing naar extern gebruikersonderzoek beschikbaar

Toegankelijkheid en robuustheid

  • ✅ Accessibility en inclusie documentatie beschikbaar
  • ✅ Semantiek (roles, names, states in HTML/ARIA) goedgekeurd door kernteam
  • ✅ Implementatie en documentatie getest op toegankelijkheid door kernteam
  • ✅ Getest op geschiktheid voor internationalisatie
  • ✅ Component kan omgaan met verschillende soorten content

Publicatie en onderhoud

  • ✅ Codebase gebruikt linting en Prettier volgens NL Design System configuraties
  • ✅ Gepubliceerd op NPM in de scope: @nl-design-system-unstable
  • ✅ Changelog wordt gepubliceerd bij nieuwe versies
  • ✅ Documentatie is getest bij doelgroepen en goed bevonden
  • ✅ Status bijgewerkt naar Candidate

Candidate componenten bekijken

Bekijk alle Candidate componenten:

Vragen?

Heb je een vraag over Candidate componenten?