Zum Inhalt springen
Dokumentation

Dokumentation

NEODIN UI

Beta

Komponenten, Design-Tokens und Leitfäden für NEODIN-Oberflächen – React, Tailwind CSS 4, hell und dunkel.

NEODIN UI ist die Komponentenbibliothek für die Oberflächen von NEODIN. Sie liefert Formulare, Tabellen, Navigation und Rückmeldungen als fertige React-Komponenten – abgestimmt auf die Marke: Navy trägt, Orange setzt Akzente, hell und dunkel sind von Anfang an dabei.

Die Bibliothek ist keine Sammlung von Einzelteilen. Jede Komponente folgt denselben Regeln für Abstände, Fokus und Statusfarben. Wer eine Schaltfläche einbaut, bekommt deshalb automatisch dasselbe Verhalten wie im Dienstplan, im Ticket oder auf der Station.

Was ist NEODIN UI?

  • Fertige Bausteine. Über 60 Komponenten von Button bis DataTable, dazu Provider für Locale, Dichte und Dunkelmodus.
  • Barrierefreiheit als Standard. Sichtbarer Fokus, Tastaturbedienung und beschriftete Formularfelder sind Teil jeder Komponente und werden getestet.
  • Deutsch zuerst. Die Texte sind auf Deutsch, die Formate folgen de-AT – Datum, Zahl und Uhrzeit eingeschlossen.
  • Eine Quelle. Doku, Beispiele und Library stammen aus demselben Paket. Was hier steht, läuft so auch in der Anwendung.

Wie die Doku aufgebaut ist

Jede Komponente hat eine eigene Seite: Kurzbeschreibung, wann sie passt und wann nicht, lauffähige Beispiele mit dem passenden Quelltext, ein Baukasten zum Ausprobieren und eine Props-Tabelle aus den TypeScript-Typen. Die Leitfäden zeigen danach ganze Abläufe, etwa ein Formular mit Validierung.

Nächste Schritte

Beginne bei der Installation, wenn du die Library in eine Anwendung einbindest. Für die tägliche Arbeit reicht der Blick in die Komponenten: Die Beispiele lassen sich direkt übernehmen, die Texte sind für den deutschen Dienstbetrieb geschrieben.

tsx
import { Button, NeodinProvider } from "@neodin-eu/ui";
import "@neodin-eu/ui/styles.css";

export function App() {
  return (
    <NeodinProvider locale="de-AT">
      <Button>Dienstplan veröffentlichen</Button>
    </NeodinProvider>
  );
}