JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6708
  • Score
    100M100P100Q128493F
  • License EUPL-1.2

Breadcrumb navigation component for the Municipality of Utrecht based on the NL Design System architecture

Package Exports

  • @utrecht/breadcrumb-nav-css
  • @utrecht/breadcrumb-nav-css/dist/index.css
  • @utrecht/breadcrumb-nav-css/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@utrecht/breadcrumb-nav-css) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Breadcrumb navigation

Breadcrumb navigation, ook wel "kruimelpad" genoemd, gebruik je als de pagina's van je site georganiseerd zijn in een boomstructuur. Als je site teveel pagina's heeft om naar elke pagina een link te maken op de homepage bijvoorbeeld. De eerste link is altijd naar de homepage.

Het kruimelpad moet alleen links bevatten naar hogere niveau's of eerdere stappen. De pagina zelf is niet onderdeel van het kruimelpad. Gebruik geen breadcrumb navigation op de homepage, want die heeft geen hogere niveaus.

HTML

Gebruik een nav element, want het is handig dat het kruimelpad een navigation landmark is. Het kruimelpad is zelden de enige navigation landmark op de pagina en landmarks moeten wel duidelijk te onderscheiden zijn. Gebruik daarom aria-label of aria-labelledby met een duidelijk label.

Gebruik een heading element met aria-labelledby, zodat het label zichtbaar is wanneer de CSS niet geladen kan worden. Zonder stijl is het kruimelpad niet duidelijk herkenbaar, dan maakt de heading dat duidelijk.

De breadcrumb navigation is niet een onderdeel dat opgezocht wordt via heading navigatie van een screen reader. Verberg de heading met aria-hidden="true" zodat de headings uit de main content sneller te vinden zijn.

Bijvoorbeeld:

<nav aria-labelledby="breadcrumb-heading">
  <h2 id="breadcrumb-heading" aria-hidden="true">Kruimelpad</h2>
  ...kruimelpad...
</nav>

Gebruik rel om duidelijk te maken wat het doel is van de links. (WCAG eis 1.3.6). Gebruik rel="home" voor de link naar de homepage (deze relatie is nog slechts een voorstel). Gebruik rel="up" voor pagina's die één niveau hoger zijn in een hierarchie. Gebruik rel="first" voor de eerste pagina in een serie.

Hoe het niet moet

Plaats het <nav> HTML-element met de breadcrumb navigation niet binnen de main page content, ofwel het <main> HTML-element.

Niet:

<main>
  <nav class="breadcrumbs">
    <a href="/">Home</a> /
    <a href="/contact" aria-current="page">Contact</a>
  </nav>
  <h1>Contact</h1>
</main>

Wel:

<nav class="breadcrumbs">
  <a href="/">Home</a> /
  <a href="/contact" aria-current="page">Contact</a>
</nav>
<main>
  <h1>Contact</h1>
</main>

Relevante WCAG regels