Zum Inhalt springen
Dokumentation

Grundlagen

Texte und Sprache

Stabil

Der Textkatalog der Library, Platzhalter mit formatMessage, Formate für de-AT und Regeln für deutsche UI-Texte.

NeodinProvider bringt zwei Dinge mit, die jede Oberfläche braucht: eine Sprache für Formate und einen Katalog für die Texte, die in den Komponenten stecken. Beides liegt an einer Stelle und gilt für alles darunter.

Sprache wählen

locale ist standardmäßig de-AT. Beginnt der Wert mit de, verwendet die Library den deutschen Katalog, sonst den englischen. Auf die Zahlen- und Datumsformate wirkt locale direkt: NumberInput, StatTile, FileUpload, die Diagramme und Timeline formatieren mit der Sprache aus dem Provider.

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

export function App({ children }: { children: React.ReactNode }) {
  return <NeodinProvider locale="de-AT">{children}</NeodinProvider>;
}

Der Katalog

Alle Bedienungstexte stehen in packages/ui/src/lib/messages.ts als flache Zuordnung von Schlüssel zu Text. Die Tabelle liest das Modul beim Bauen der Seite und zeigt beide Fassungen; sie kann deshalb nicht veralten.

Textkatalog aus packages/ui/src/lib/messages.ts – alle Schlüssel mit deutscher und englischer Fassung
SchlüsselDeutschEnglischPlatzhalter
noResultsKeine TrefferNo results—
noEntriesKeine EinträgeNo entries—
loadingWird geladen …Loading …—
closeSchließenClose—
searchSuchen …Search …—
previousZurückPrevious—
nextWeiterNext—
pageSeite {page} von {total}Page {page} of {total}{page} {total}
rowsSelected{count} ausgewählt{count} selected{count}
themeLightHellLight—
themeDarkDunkelDark—
themeSystemSystemSystem—
copyKopierenCopy—
copiedKopiertCopied—
codeCodeCode—
requiredPflichtfeldRequired—
invalidDateUngültiges DatumInvalid date—
showPasswordPasswort anzeigenShow password—
hidePasswordPasswort verbergenHide password—
removeItem{label} entfernenRemove {label}{label}
dropFilesDateien hierher ziehen oder auswählenDrag files here or choose files—
fileTooLargeDatei ist größer als {max}File is larger than {max}{max}
fileTypeNotAllowedDateityp nicht erlaubtFile type not allowed—
toggleSidebarSeitenleiste umschaltenToggle sidebar—
sidebarSeitenleisteSidebar—
breadcrumbBrotkrümelnavigationBreadcrumb—
moreActionsWeitere AktionenMore actions—
selectAllAlle auswählenSelect all—
selectRowZeile auswählenSelect row—
columnsSpaltenColumns—
retryErneut versuchenRetry—
commandPaletteBefehlspaletteCommand palette—
selectOptionAuswählenSelect—
dateDatumDate—
dateRangeZeitraumDate range—
rangeStartVonFrom—
rangeEndBisTo—
openCalendarKalender öffnenOpen calendar—
timeUhrzeitTime—
invalidTimeUngültige UhrzeitInvalid time—
errorTitleEtwas ist schiefgelaufenSomething went wrong—
paginationSeitennavigationPagination—
goToPageSeite {page}Page {page}{page}
stepCompletedAbgeschlossenCompleted—
stepCurrentAktueller SchrittCurrent step—
stepUpcomingAusstehendUpcoming—
trendUpsteigendincreasing—
trendDownfallenddecreasing—
trendFlatunverändertunchanged—

Wer einen Schlüssel braucht, liest ihn über useNeodinMessages() in einer Client-Komponente. Für eigene Texte außerhalb der Library ist der Katalog nicht gedacht: Feldnamen und Erklärungen deiner Anwendung kommen aus deiner Anwendung.

Platzhalter und formatMessage

Fünf Schlüssel enthalten Platzhalter in geschweiften Klammern: page, rowsSelected, removeItem, fileTooLarge und goToPage. formatMessage setzt sie ein; unbekannte Platzhalter bleiben stehen, damit nichts stillschweigend verschwindet.

tsx
import { deMessages, formatMessage } from "@neodin-eu/ui";

formatMessage(deMessages.page, { page: 2, total: 7 });
formatMessage(deMessages.removeItem, { label: "Übergabeprotokoll" });
formatMessage(deMessages.page, { page: 2 });

Die drei Aufrufe ergeben „Seite 2 von 7“, „Übergabeprotokoll entfernen“ und „Seite 2 von {total}“: Der fehlende Platzhalter bleibt sichtbar, statt stillschweigend zu verschwinden.

Gibst du keine Variablen mit, kommt die Vorlage unverändert zurück. Das Verhalten ist im Library-Test (messages.test.ts) abgesichert.

Einzelne Texte überschreiben

messages am Provider ersetzt nur die genannten Schlüssel; alle anderen bleiben beim Standard. So heißt eine leere Ergebnisliste „Nichts gefunden“, ohne dass du den ganzen Katalog kopieren musst:

tsx
<NeodinProvider messages={{ noResults: "Nichts gefunden" }}>{children}</NeodinProvider>

Die vollständige Beschreibung samt Beispiel steht unter NeodinProvider.

Formate für de-AT

Die Library formatiert nach der Sprache aus dem Provider, nicht nach der Sprache des Browsers. Mit de-AT gilt:

WertAusgabeKomponente
1234.51.234,5NumberInput, StatTile
5000000 Bytes5 MBFileUpload
Datum 19.11.202619.11.2026DatePicker, DateRangePicker
Uhrzeit 08:3008:30 (24-Stunden-Anzeige)TimePicker
Zeitstempel19.11.2026, 08:30Timeline
Diagrammwert1.234,5Diagramme (Tooltip)

Zahlen laufen über Intl.NumberFormat, Datumsfelder über date-fns mit der Locale de-AT und dem Muster dd.MM.yyyy; die Woche beginnt am Montag. Die Uhrzeit ist immer HH:mm im 24-Stunden-Format. Eigene Texte formatiert deine Anwendung mit demselben Intl-Aufruf und derselben Locale, damit die Seite einheitlich bleibt.

Schreibregeln

Knöpfe nennen die Handlung

Ein Knopf sagt, was passiert, nicht dass etwas passiert: „Dienstplan veröffentlichen“ statt „OK“, „Schicht tauschen“ statt „Senden“. Ein kurzes Verb und ein Objekt reichen. Für Abbrechen und Zurück gibt es Button variant="outline" und variant="ghost"; die Beschriftung bleibt trotzdem konkret („Änderungen verwerfen“).

Du oder Sie: eine Entscheidung pro Produkt

Der Katalog der Library adressiert niemanden direkt. Die Texte sind neutral und unpersönlich: „Keine Treffer“, „Wird geladen …“, „Schließen“, „Weiter“. Das ist Absicht – die Library legt die Anrede nicht fest.

Ob ein Produkt die Mitarbeitenden duzt oder siezt, entscheidet das Produkt und hält es über alle Seiten, Formulare und Fehlermeldungen durch. Ein Wechsel mitten im Ablauf („Bitte wählen Sie …“ neben „Gib den Grund an“) liest sich wie ein Fehler. Diese Doku verwendet durchgehend „du“.

Typografie

  • Deutsche Anführungszeichen: „Dienstplan“ – nicht "Dienstplan".
  • Halbgeviertstrich für Bereiche und Gegensätze: 08:00–16:00, Hell–Dunkel. Nie einen Bindestrich als Gedankenstrich verwenden.
  • Auslassungspunkte als einzelnes Zeichen mit Leerzeichen davor, wie im Katalog: „Wird geladen …“, „Suchen …“.
  • Ein Leerzeichen nach dem Doppelpunkt, keines vor Satzzeichen. Umlaute ausschreiben („Übergabe“), nicht Uebergabe.

Fehlermeldungen sagen, was zu tun ist

Eine Meldung nennt das Feld und den nächsten Schritt: „Bitte gib das Datum der Schicht an.“ Statt nur „Ungültig“. Die Library liefert für ihre Bausteine kurze Texte wie „Ungültiges Datum“ (invalidDate) oder „Pflichtfeld“ (required); die fachliche Meldung schreibt die Anwendung. Wie Fehler mit dem Feld verbunden werden, steht unter Formular (Form).

Keine Patientendaten in Beispielen

Beispiele und Screenshots zeigen Rollen, Stationen und Abläufe, keine echten Personen: „Station 3“, „Frühdienst“, „Zimmer 102“. Namen in Beispielen sind erfunden. Das gilt auch für Fehlermeldungen und Logs in der Doku.

Barrierefreiheit

  • Katalogtexte sind zugängliche Namen: copy, close, toggleSidebar und removeItem beschriften Knöpfe und werden vorgelesen. Überschreib sie nicht mit leerem Text – sonst verliert der Knopf seinen Namen.
  • Platzhalter gehören in den Satz, nicht an den Rand: „Übergabeprotokoll entfernen“ liest sich für Screenreader wie für alle anderen.
  • Sprachwechsel am Dokument setzen: <html lang="de">. Die Seitensprache hilft Screenreadern bei Aussprache und Silbentrennung.
  • Gekürzte Texte („…“) brauchen den vollständigen Text als zugänglichen Namen, etwa über aria-label oder einen Tooltip mit Text.

Siehe auch