Zum Inhalt springen
Dokumentation

Komponenten

Navigationsmenü (NavigationMenu)

Stabil

Feste Bereiche einer Anwendung in einer Leiste – mit aufklappbaren Untermenüs und einer gemeinsamen Ansichtsfläche.

Das Navigationsmenü führt zu den festen Bereichen einer Anwendung: Station, Dienstplan, Hilfe. Ein Eintrag mit Untermenü klappt seine Ziele in einer gemeinsamen Fläche auf, ohne die Seite zu verlassen.

Wann verwenden

  • Für die Hauptnavigation einer Anwendung mit wenigen, festen Bereichen.
  • Wenn ein Bereich mehrere Unterziele hat, die nicht dauerhaft sichtbar sein müssen.
  • Wenn die Navigation auch ohne Maus erreichbar sein soll: Die Einträge lassen sich mit der Tastatur durchgehen.

Wann nicht

  • Für Aktionen wie „Dienstplan veröffentlichen“ ist ein Menü die richtige Wahl; Navigation führt zu Orten, nicht zu Befehlen.
  • Bei vielen Bereichen ist eine Seitenleiste mit Gruppen übersichtlicher.
  • Für Ansichten derselben Seite genügen Reiter; die Seite bleibt dabei dieselbe.
  • Für die Navigation einer einzelnen Seite reichen Brotkrümel oder ein einfacher Link.

Aufbau

NavigationMenu ist die Leiste selbst, NavigationMenuList hält die Einträge, NavigationMenuItem fasst einen Eintrag zusammen. NavigationMenuTrigger öffnet ein Untermenü, NavigationMenuContent hält dessen Ziele, NavigationMenuLink ist ein Verweis. Die gemeinsame Ansichtsfläche (NavigationMenuViewport) hängt NavigationMenu selbst ein.

Beispiel und Quelltext
hauptnavigation.tsx
import Link from "next/link";

import {
  NavigationMenu,
  NavigationMenuContent,
  NavigationMenuItem,
  NavigationMenuLink,
  NavigationMenuList,
  NavigationMenuTrigger,
} from "@neodin-eu/ui";

function Hauptnavigation() {
  return (
    <NavigationMenu aria-label="Bereiche der Anwendung">
      <NavigationMenuList>
        <NavigationMenuItem>
          <NavigationMenuTrigger>Station</NavigationMenuTrigger>
          <NavigationMenuContent>
            <ul className="grid w-56 gap-1 p-1">
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/reiter">Bettenbelegung</Link>
                </NavigationMenuLink>
              </li>
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/schritte">Übergabe</Link>
                </NavigationMenuLink>
              </li>
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/brotkrumen">Stationspfad</Link>
                </NavigationMenuLink>
              </li>
            </ul>
          </NavigationMenuContent>
        </NavigationMenuItem>
        <NavigationMenuItem>
          <NavigationMenuTrigger>Dienstplan</NavigationMenuTrigger>
          <NavigationMenuContent>
            <ul className="grid w-56 gap-1 p-1">
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/reiter">Wochenplan</Link>
                </NavigationMenuLink>
              </li>
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/formulare/auswahl">Schichtauswahl</Link>
                </NavigationMenuLink>
              </li>
            </ul>
          </NavigationMenuContent>
        </NavigationMenuItem>
        <NavigationMenuItem>
          <NavigationMenuLink asChild>
            <Link href="/docs">Hilfe</Link>
          </NavigationMenuLink>
        </NavigationMenuItem>
      </NavigationMenuList>
    </NavigationMenu>
  );
}

Ohne gemeinsame Ansicht

Mit viewport={false} erscheint der Inhalt direkt unter dem Auslöser statt in der gemeinsamen Fläche. Das passt, wenn sich die Menüs deutlich unterscheiden und die Leiste in einer schmalen Spalte steht.

Beispiel und Quelltext
ohne-ansicht.tsx
import Link from "next/link";

import {
  NavigationMenu,
  NavigationMenuContent,
  NavigationMenuItem,
  NavigationMenuLink,
  NavigationMenuList,
  NavigationMenuTrigger,
} from "@neodin-eu/ui";

function OhneAnsicht() {
  return (
    <NavigationMenu aria-label="Stationsnavigation" viewport={false}>
      <NavigationMenuList>
        <NavigationMenuItem>
          <NavigationMenuTrigger>Schichten</NavigationMenuTrigger>
          <NavigationMenuContent>
            <ul className="grid w-48 gap-1 p-1">
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/reiter">Frühdienst</Link>
                </NavigationMenuLink>
              </li>
              <li>
                <NavigationMenuLink asChild>
                  <Link href="/docs/komponenten/navigation/reiter">Spätdienst</Link>
                </NavigationMenuLink>
              </li>
            </ul>
          </NavigationMenuContent>
        </NavigationMenuItem>
        <NavigationMenuItem>
          <NavigationMenuLink asChild>
            <Link href="/docs">Start</Link>
          </NavigationMenuLink>
        </NavigationMenuItem>
      </NavigationMenuList>
    </NavigationMenu>
  );
}

Barrierefreiheit

  • NavigationMenu rendert ein nav-Element. Der zugängliche Name kommt aus aria-label – im Komponententest „Hauptnavigation“.
  • Die Auslöser sind Schaltflächen. Enter öffnet das Untermenü, Escape schließt es; der Test prüft aria-expanded vor und nach dem Tastendruck.
  • Die Pfeiltasten bewegen den Fokus zwischen den obersten Einträgen. ArrowDown führt in das geöffnete Untermenü zum ersten Verweis. Beides ist im Komponententest abgesichert.
  • Radix öffnet ein Untermenü auch beim Überfahren mit der Maus. Die Ziele im Untermenü sind normale Links.
  • Der offene Zustand ist im Komponententest in hell und dunkel frei von axe-Verstößen. Radix hält dabei einen Fokus-Platzhalter (aria-hidden mit tabIndex=0) im DOM; für ihn blendet der Test die axe-Regel aria-hidden-focus aus.

Props

Props von NavigationMenu
PropTypStandardPflichtBeschreibung
asChildboolean–Nein–
classNamestring–Nein–
defaultValuestring–Nein–
onValueChange((value: string) => void)–Nein–
valuestring–Nein–
viewportbooleantrueNeinRenders the shared viewport under the trigger; defaults to `true`.

Der Auslöser und der Inhalt tragen die Attribute der Radix-Grundlage:

Props von NavigationMenuTrigger
PropTypStandardPflichtBeschreibung
asChildboolean–Nein–
classNamestring–Nein–
disabledboolean–Nein–
Props von NavigationMenuContent
PropTypStandardPflichtBeschreibung
asChildboolean–Nein–
classNamestring–Nein–
Props von NavigationMenuLink
PropTypStandardPflichtBeschreibung
asChildboolean–Nein–
classNamestring–Nein–

Siehe auch