Zum Inhalt springen
Dokumentation

Komponenten

NeodinProvider

Stabil

Sprache, Dichte und alle UI-Texte an einer Stelle – de-AT als Standard, kompakt für dichte Stationslisten.

NeodinProvider hält drei Dinge für alle Komponenten bereit: die Sprache (locale), die Dichte (density) und den Katalog der UI-Texte (messages). Er sitzt einmal im Root-Layout; darunter greifen Komponenten über useNeodin und useNeodinMessages darauf zu. Ohne Provider gelten de-AT, comfortable und der deutsche Katalog.

Wann verwenden

  • Immer, einmal pro Anwendung, im Root-Layout.
  • Wenn Oberflächen dichter werden sollen: In Stationsübersichten mit vielen Zeilen passt density="compact", in Formularen am Empfang comfortable.
  • Wenn einzelne Texte anders lauten sollen, etwa „Nichts gefunden“ statt „Keine Treffer“.
  • Wenn die Oberfläche englisch laufen soll: locale="en-GB" schaltet auf den englischen Katalog.

Wann nicht

  • Nicht als Übersetzungshilfe für Fachinhalte. Der Katalog enthält Bedienungstexte der Komponenten; Seiteninhalte und Beschriftungen deiner Formulare kommen aus deiner Anwendung.
  • Nicht mehrfach verschachteln, um einzelne Komponenten umzustellen. Ein Provider pro Dokument reicht.
  • Nicht für Zahlenformate in eigenen Texten: NumberInput formatiert nach locale, eigener Text gehört in Intl deiner Anwendung.

Einrichten

Im Root-Layout (app/layout.tsx) sitzt der Provider innerhalb von <body>, unter dem ThemeProvider:

tsx
import { NeodinProvider, ThemeProvider } from "@neodin-eu/ui";

export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="de" suppressHydrationWarning>
      <body>
        <ThemeProvider>
          <NeodinProvider locale="de-AT">{children}</NeodinProvider>
        </ThemeProvider>
      </body>
    </html>
  );
}

Sprache und Texte

Der Katalog ist eine flache Zuordnung von Schlüssel zu Text; Platzhalter stehen in geschweiften Klammern und werden von formatMessage gefüllt. Beginnt locale mit de, gilt der deutsche Katalog, sonst der englische. Übergebenes messages überschreibt nur die genannten Schlüssel.

SchlüsselVorlageAusgabe
pageSeite {page} von {total}Seite 2 von 7
rowsSelected{count} ausgewählt3 ausgewählt
removeItem{label} entfernenAnhang Übergabeprotokoll entfernen
fileTooLargeDatei ist größer als {max}Datei ist größer als 10 MB
messages={{ noResults: „Nichts gefunden“ }}
Nichts gefunden · Keine Einträge
locale="en-GB"
No results · No entries
Beispiel und Quelltext
texte.tsx
import {
  NeodinProvider,
  Table,
  TableBody,
  TableCell,
  TableHead,
  TableHeader,
  TableRow,
  formatMessage,
  useNeodinMessages,
} from "@neodin-eu/ui";

function Katalog() {
  const messages = useNeodinMessages();
  const zeilen = [
    {
      schluessel: "page",
      vorlage: messages.page,
      ausgabe: formatMessage(messages.page, { page: 2, total: 7 }),
    },
    {
      schluessel: "rowsSelected",
      vorlage: messages.rowsSelected,
      ausgabe: formatMessage(messages.rowsSelected, { count: 3 }),
    },
    {
      schluessel: "removeItem",
      vorlage: messages.removeItem,
      ausgabe: formatMessage(messages.removeItem, { label: "Anhang Übergabeprotokoll" }),
    },
    {
      schluessel: "fileTooLarge",
      vorlage: messages.fileTooLarge,
      ausgabe: formatMessage(messages.fileTooLarge, { max: "10 MB" }),
    },
  ];

  return (
    <Table>
      <TableHeader>
        <TableRow>
          <TableHead>Schlüssel</TableHead>
          <TableHead>Vorlage</TableHead>
          <TableHead>Ausgabe</TableHead>
        </TableRow>
      </TableHeader>
      <TableBody>
        {zeilen.map(({ schluessel, vorlage, ausgabe }) => (
          <TableRow key={schluessel}>
            <TableCell className="font-mono text-xs">{schluessel}</TableCell>
            <TableCell className="font-mono text-xs">{vorlage}</TableCell>
            <TableCell>{ausgabe}</TableCell>
          </TableRow>
        ))}
      </TableBody>
    </Table>
  );
}

function Meldung({ schluessel }: { schluessel: "noResults" | "noEntries" }) {
  const messages = useNeodinMessages();

  return <span>{messages[schluessel]}</span>;
}

function Texte() {
  return (
    <div className="flex w-full max-w-xl flex-col gap-6">
      <Katalog />
      <div className="grid gap-3 sm:grid-cols-2">
        <div className="flex flex-col gap-1 rounded-md border border-border bg-background p-4">
          <span className="font-mono text-xs text-muted-foreground">
            {"messages={{ noResults: „Nichts gefunden“ }}"}
          </span>
          <NeodinProvider messages={{ noResults: "Nichts gefunden" }}>
            <span className="text-sm text-foreground">
              <Meldung schluessel="noResults" /> · <Meldung schluessel="noEntries" />
            </span>
          </NeodinProvider>
        </div>
        <div className="flex flex-col gap-1 rounded-md border border-border bg-background p-4">
          <span className="font-mono text-xs text-muted-foreground">{'locale="en-GB"'}</span>
          <NeodinProvider locale="en-GB">
            <span className="text-sm text-foreground">
              <Meldung schluessel="noResults" /> · <Meldung schluessel="noEntries" />
            </span>
          </NeodinProvider>
        </div>
      </div>
    </div>
  );
}

formatMessage lässt unbekannte Platzhalter stehen: Wer nur page übergibt, erhält „Seite 2 von“ und dahinter den unveränderten Platzhalter für die Gesamtzahl. Ohne Variablen gibt es die Vorlage unverändert zurück.

Dichte

density kennt zwei Werte: comfortable (Standard) und compact. Der Provider setzt dafür data-density auf ein Hüllenelement; die Styles verkleinern die Höhe der Eingabefelder und den Abstand in Tabellenzellen.

Werte der beiden Dichte-Stufen
Eigenschaftcomfortable (Standard)compact
Höhe der Eingabefelder2,25 rem (36 px)1,875 rem (30 px)
Abstand in Tabellenzellen0,75 rem (12 px)0,375 rem (6 px)
Beispiel und Quelltext
dichte.tsx
import * as React from "react";

import {
  Label,
  NeodinProvider,
  NumberInput,
  Switch,
  Table,
  TableBody,
  TableCaption,
  TableCell,
  TableHead,
  TableHeader,
  TableRow,
} from "@neodin-eu/ui";

const STUFEN = [
  {
    eigenschaft: "Höhe der Eingabefelder",
    komfortabel: "2,25 rem (36 px)",
    kompakt: "1,875 rem (30 px)",
  },
  {
    eigenschaft: "Abstand in Tabellenzellen",
    komfortabel: "0,75 rem (12 px)",
    kompakt: "0,375 rem (6 px)",
  },
] as const;

function Dichte() {
  const [kompakt, setKompakt] = React.useState(true);
  const [betten, setBetten] = React.useState<number | null>(4);

  return (
    <div className="flex w-full max-w-xl flex-col gap-6">
      <div className="flex items-center justify-between gap-4">
        <Label htmlFor="dichte-kompakt">Kompakte Dichte</Label>
        <Switch id="dichte-kompakt" checked={kompakt} onCheckedChange={setKompakt} />
      </div>

      <NeodinProvider density={kompakt ? "compact" : "comfortable"}>
        <div className="flex flex-col gap-2 rounded-md border border-border bg-background p-4">
          <Label htmlFor="dichte-betten">Freie Betten, Station 3</Label>
          <NumberInput
            id="dichte-betten"
            value={betten}
            onValueChange={setBetten}
            min={0}
            max={24}
          />
        </div>
      </NeodinProvider>

      <Table>
        <TableCaption>Werte der beiden Dichte-Stufen</TableCaption>
        <TableHeader>
          <TableRow>
            <TableHead>Eigenschaft</TableHead>
            <TableHead>comfortable (Standard)</TableHead>
            <TableHead>compact</TableHead>
          </TableRow>
        </TableHeader>
        <TableBody>
          {STUFEN.map((stufe) => (
            <TableRow key={stufe.eigenschaft}>
              <TableCell>{stufe.eigenschaft}</TableCell>
              <TableCell>{stufe.komfortabel}</TableCell>
              <TableCell>{stufe.kompakt}</TableCell>
            </TableRow>
          ))}
        </TableBody>
      </Table>
    </div>
  );
}

Die Werte gelten über die CSS-Variablen --control-h und --cell-py. Sie wirken in Button, Input und allen Eingabefeldern, die ihre Höhe daraus ziehen – NumberInput, PasswordInput, InputOTP, TagInput, Combobox, Command, DatePicker, DateRangePicker und TimePicker – sowie in den Zellen der DataTable. Welche Höhen fest bleiben, steht unter Dichte.

Barrierefreiheit

  • Der Provider rendert ein div mit display: contents und data-density. Es hat keine Rolle, keinen Fokus und erzeugt keinen sichtbaren Kasten; der Komponententest prüft das Attribut.
  • Die Katalogtexte sind zugängliche Namen: copy, close und toggleSidebar beschriften Knöpfe, removeItem bekommt den Namen des Eintrags über den Platzhalter, etwa „Anhang entfernen“.
  • Überschreib messages mit verständlichen Texten; sie werden vorgelesen. Leere Texte nehmen Screenreadern die Beschriftung.
  • locale wirkt auf die Zahlenformatierung von NumberInput; Fachtexte deiner Anwendung bleiben davon unberührt.

Props

Props von NeodinProvider
PropTypStandardPflichtBeschreibung
childrenReactNode–NeinApplication tree that receives the provider context.
densityenumcomfortableNeinControl density for all descendants; defaults to `"comfortable"`.
localestringde-ATNeinBCP 47 locale for dates and numbers; defaults to `"de-AT"`.
messagesPartial<NeodinMessages>–NeinOverrides for individual catalog strings.

Siehe auch