Skip to main content
Digitaltableteur

Design system components

NavMenuList

Navigation list for drawer and mobile menus that renders link items and marks the active one from the current route.

Status: beta. Group: navigation. Markdown version: /design-system/components/nav-menu-list.md

When to use

Navigation list for drawer and mobile menus: renders link items and derives the active item from the current route. Site chrome building block.

When not to use

The contract records no forbidden uses.

Look-alikes

  • Menu: Do not reach for Menu to build primary site navigation; navigation is a list of links (NavMenuList), not an actions menu; forcing role=menu onto nav is an a11y regression.
  • SiteTree: Do not use as the primary site header navigation; use NavMenuList / SiteHeader instead.
  • TableOfContents: Do not use for global site navigation; use NavMenuList or SiteTree instead.

Props

NavMenuList props
PropTypeDefaultDescriptionRequired
itemsNavMenuItem[]noneNo description in the contract.Yes
onNavigate() => voidnoneNo description in the contract.No
activeClassNamestringnoneNo description in the contract.No
listClassNamestringnoneNo description in the contract.No
itemClassNamestringnoneNo description in the contract.No

Variants

No variant dimensions and no props with a fixed set of values.

Invalid combinations

The contract records no invalid combinations.

Keyboard

The contract records no keyboard interaction.

Rules

Every item under When not to use is a MUST NOT. MUST and SHOULD follow RFC 2119.

NavMenuList rules
LevelRuleHow it is checked
MUSTRequired stories produce no axe violations at the configured severity.Automated by npm run test:stories:matrix:ci. WCAG 2.5.8.
MUSTThe accessibility tree (role, name, state) matches the committed snapshot for every required story.Automated by npm run test:stories:matrix:ci. WCAG 1.3.1, 4.1.2.
MUSTThe component remains legible and operable under a real browser forced-colors: active pass.Automated by npm run test:stories:hc.
MUSTA human completed an end-to-end accessibility review of this component.Manual review, last on 2026-05-28.
MUST NOTMaintainers: Do not bypass design tokens or skip forced-colors verification at beta.Release review; not machine-checked.

Install and import

  • Install: npm install @digitaltableteur/react (version 0.9.1, restricted access on npm).
  • Import: import { NavMenuList } from "@digitaltableteur/react";
  • Entry point: @digitaltableteur/react/navigation exports it too.
  • Styles: import @digitaltableteur/react/style.css once at the app boundary.
  • Also available as the custom element <dt-nav-menu-list>; see the custom elements manifest.

Links