Zum Inhalt springen
Dokumentation

Komponenten

App-Gerüst (AppShell, Sidebar)

Stabil

Kopfzeile, einklappbare Seitenleiste und Inhalt – der Rahmen für jede Ansicht im Dienstplan.

Das App-Gerüst trägt jede Ansicht: links die Seitenleiste mit den Bereichen, oben die Kopfzeile mit dem Umschalter, rechts der Inhalt. Auf schmalen Geräten wird aus der Seitenleiste ein Dialog.

Wann verwenden

  • Für jede Ansicht einer Anwendung mit mehreren Bereichen, etwa Dienstplan, Station und Tickets.
  • Wenn die Seitenleiste auf dem Desktop sichtbar bleibt und auf dem Tablet oder Telefon als Dialog erscheint.
  • Wenn der Zustand der Leiste erhalten bleiben soll: SidebarProvider schreibt ihn in ein Cookie.

Wann nicht

  • Für eine öffentliche Seite ohne Anmeldung ist eine einklappbare Seitenleiste meist zu viel.
  • Für eine einzelne Ansicht mit wenigen Zielen genügt eine Kopfzeile.
  • Wenn nur zwischen Ansichten derselben Seite gewechselt wird, passen Reiter.

Seitenleiste

SidebarProvider hält Zustand und Breite der Leiste, Sidebar ist die Fläche selbst. SidebarHeader, SidebarContent und SidebarFooter gliedern sie, SidebarGroup mit SidebarGroupLabel fasst Bereiche zusammen. SidebarMenu, SidebarMenuItem und SidebarMenuButton bilden die Einträge; isActive markiert die aktuelle Ansicht, tooltip zeigt die Beschriftung im zugeklappten Zustand. SidebarTrigger schaltet die Leiste um.

Frühdienst · Station 3

Sechs Dienste sind besetzt, zwei noch offen.

Beispiel und Quelltext
seitenleiste.tsx
import { CalendarDays, ClipboardList, LayoutDashboard } from "lucide-react";
import * as React from "react";

import {
  Sidebar,
  SidebarContent,
  SidebarFooter,
  SidebarGroup,
  SidebarGroupLabel,
  SidebarHeader,
  SidebarMenu,
  SidebarMenuButton,
  SidebarMenuItem,
  SidebarProvider,
  SidebarTrigger,
  useSidebar,
} from "@neodin-eu/ui";

function Eintrag({
  icon,
  label,
  active = false,
}: {
  icon: React.ReactNode;
  label: string;
  active?: boolean;
}) {
  const { state } = useSidebar();

  return (
    <SidebarMenuButton isActive={active} tooltip={label}>
      {icon}
      <span className={state === "collapsed" ? "sr-only" : undefined}>{label}</span>
    </SidebarMenuButton>
  );
}

function Seitenleiste() {
  return (
    <div className="relative w-full max-w-2xl overflow-hidden rounded-lg border border-border">
      <SidebarProvider className="h-[26rem] min-h-0 bg-background">
        <Sidebar className="h-full">
          <SidebarHeader>
            <span className="px-2 text-sm font-semibold text-foreground">Station 3</span>
          </SidebarHeader>
          <SidebarContent>
            <SidebarGroup>
              <SidebarGroupLabel>Dienstplan</SidebarGroupLabel>
              <SidebarMenu>
                <SidebarMenuItem>
                  <Eintrag icon={<LayoutDashboard />} label="Übersicht" active />
                </SidebarMenuItem>
                <SidebarMenuItem>
                  <Eintrag icon={<CalendarDays />} label="Schichten" />
                </SidebarMenuItem>
                <SidebarMenuItem>
                  <Eintrag icon={<ClipboardList />} label="Übergaben" />
                </SidebarMenuItem>
              </SidebarMenu>
            </SidebarGroup>
          </SidebarContent>
          <SidebarFooter>
            <span className="px-2 text-xs text-muted-foreground">Version 1.4</span>
          </SidebarFooter>
        </Sidebar>
        <div className="flex min-w-0 flex-1 flex-col">
          <div className="flex items-center gap-2 border-b border-border px-3 py-2">
            <SidebarTrigger />
            <span className="text-sm font-medium text-foreground">Frühdienst · Station 3</span>
          </div>
          <div className="min-h-0 flex-1 overflow-hidden p-4">
            <p className="text-sm text-muted-foreground">
              Sechs Dienste sind besetzt, zwei noch offen.
            </p>
          </div>
        </div>
      </SidebarProvider>
    </div>
  );
}

App-Gerüst

AppShell setzt die Teile zusammen: sidebar nimmt die Seitenleiste, header die Kopfzeile, children den Inhalt. defaultOpen legt den Startzustand fest, className, headerClassName und contentClassName passen Flächen und Abstände an.

tsx
import {
  AppShell,
  Sidebar,
  SidebarContent,
  SidebarMenu,
  SidebarMenuButton,
  SidebarMenuItem,
  SidebarTrigger,
} from "@neodin-eu/ui";

export function Station() {
  return (
    <AppShell
      sidebar={
        <Sidebar>
          <SidebarContent>
            <SidebarMenu>
              <SidebarMenuItem>
                <SidebarMenuButton isActive>Übersicht</SidebarMenuButton>
              </SidebarMenuItem>
              <SidebarMenuItem>
                <SidebarMenuButton>Schichten</SidebarMenuButton>
              </SidebarMenuItem>
            </SidebarMenu>
          </SidebarContent>
        </Sidebar>
      }
      header={<SidebarTrigger />}
      contentClassName="p-4"
    >
      <p>Sechs Dienste sind besetzt, zwei noch offen.</p>
    </AppShell>
  );
}

Die Vorschau oben stellt dieselben Teile ohne SidebarInset dar: Diese Dokumentationsseite besitzt bereits ein main-Element, ein zweites wäre ein Landmark-Fehler. AppShell selbst setzt SidebarInset genau dafür ein.

Barrierefreiheit

  • SidebarTrigger ist eine Schaltfläche mit dem zugänglichen Namen „Seitenleiste umschalten“. aria-expanded spiegelt den Zustand; der Komponententest klickt den Umschalter und prüft den Wechsel von true auf false.
  • Strg+B und ⌘+B schalten die Seitenleiste ebenfalls um; das ist im Komponententest abgesichert.
  • Der aktive Eintrag trägt aria-current="page". Der Test prüft das am Eintrag „Übersicht“.
  • Zugeklappt erscheint die Beschriftung eines Eintrags als Tooltip, sobald er den Fokus erhält; der Test prüft genau das.
  • Unter 768 px rendert die Seitenleiste als Dialog mit der Rolle dialog und einem eigenen Titel. Der Trigger öffnet sie und beschreibt sie mit aria-expanded.
  • SidebarMenuButton rendert ein natives button; mit asChild kann ein Link an seine Stelle treten.
  • Der dargestellte Zustand ist im Komponententest in hell und dunkel frei von axe-Verstößen.

Props

Props von AppShell
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
contentClassNamestring–NeinAdditional classes for the main content area.
defaultOpenboolean–NeinWhether the sidebar starts expanded; defaults to the sidebar's own default.
headerReactNode–NeinContent of the optional top header bar.
headerClassNamestring–NeinAdditional classes for the header bar.
sidebarReactNode–JaSidebar content rendered next to the main area (usually `<Sidebar>`).
Props von Sidebar
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
Props von SidebarProvider
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
defaultOpenbooleantrueNeinWhether the sidebar starts expanded; defaults to `true`.
Props von SidebarTrigger
PropTypStandardPflichtBeschreibung
asChildboolean–NeinRender the child element instead of a `<button>` (Radix Slot).
classNamestring–Nein–
disabledboolean–Nein–
size"default" | "sm" | "lg" | "icon" | null–NeinHeight and padding preset; all presets follow the density (`--control-h`).
variant"link" | "default" | "secondary" | "destructive" | "outline" | "ghost" | null–NeinVisual style of the button; defaults to `"default"`.
Props von SidebarMenuButton
PropTypStandardPflichtBeschreibung
asChildbooleanfalseNeinRender the child element instead of a `<button>` (Radix Slot).
classNamestring–Nein–
disabledboolean–Nein–
isActivebooleanfalseNeinMarks the button as the current page; defaults to `false`.
tooltipReactNode–NeinLabel shown in a tooltip while the sidebar is collapsed.

Siehe auch