Frontend-Contract: Hier starten
Wippy-Frontend-Module sind standardmäßig portabel. Ein Modul muss weiterhin funktionieren, wenn es in ein anderes Wippy-Projekt importiert wird, dessen Facade ein anderes konformes PrimeVue-Theme liefert und kein projektinternes CSS bereitstellt.
Den richtigen Weg wählen
- Verwende eine
view.pagefür eine Anwendung, die in einemabout:srcdoc-Iframe gerendert wird. - Verwende eine
view.componentfür ein Custom Element, das im Host-Dokument gerendert wird, normalerweise mit einem Shadow Root. - Wenn die UI einen Button, ein Eingabefeld, ein Formularfeld, ein Menü, ein Overlay oder ein anderes PrimeVue-artiges Steuerelement rendert, verwende PrimeVue, sofern es die erforderliche Semantik und Bedienbarkeit nicht liefern kann.
- Eine reine Inhaltskomponente, etwa eine Chart.js-Visualisierung ohne Steuerelemente, darf auf PrimeVue und Tailwind verzichten.
- Ist ein eigenes Steuerelement notwendig, folge dem Portable-UI-Contract und Eigene Composites.
PrimeVue ist das gemeinsame Komponenten-Vokabular. Das Wippy-Tailwind-Preset ist ein unterstütztes Vokabular zur Build-Zeit. Nur Utilities, die als laufzeitgestützt dokumentiert sind, reagieren nach der Kompilierung weiterhin auf Theme-Wechsel der Facade.
Zuständigkeitskarte
module source
-> build command
-> emitted artifact
-> registry owner
-> served URL
-> Web Host
-> page srcdoc iframe or component shadow root
-> AppConfig / router / theme delivery
Leite keine Stufe aus einer anderen ab. Bevor du ein fehlendes Asset debuggst, identifiziere das Quellpaket, das Build-Ziel, die emittierte Datei, den Registry-Eintrag, den Dateisystem-Mount und die ausgelieferte URL.
Contract-Seiten
- Plattform-Topologie: Laufzeitgrenzen, Routing, CSS-Auslieferung, Overlays und Zuständigkeiten.
- Portable-UI-Contract: normative Regeln für Komponenten und Styling.
- Theme-Authoring: was in
custom_cssder Facade, in das PrimeVue-Theme-CSS oder in ein Modul gehört. - Tailwind-Contract: laufzeitgestützte Utilities gegenüber kompilierten Konstanten.
- Token-Katalog: generierte Token-Referenz und Herkunft.
- Die Design-Schicht: wohin etwas gehört, wenn mehrere deiner eigenen Module es benötigen und das Theme keine passende Komponente hat.
- Rezept für Seiten und Rezept für Web-Komponenten.
- Build- und Abhängigkeits-Contract.
- Konfiguration und Schreibweise.
- Index der Compliance-Regeln.
Nicht verhandelbare Prüfungen
- Erfinde niemals eine PrimeVue-Prop, eine Komponenten-API, eine CSS-Variable oder eine semantische Tailwind-Utility. Verifiziere sie in der Quelle des gewählten Pakets und im generierten Katalog.
- Konstruiere niemals einen
--p-*-Token-Namen per Analogie. - Fordere aus einem portablen Modul niemals eine beliebige Facade-Klasse ein.
- Leite den Routing-Kontext des Hosts niemals aus der Browser-Location ab. Seiten erhalten den Host-Kontext über AppConfig und verwenden
@wippy-fe/router. - Baue vor der Browser-Verifikation genau das zuständige Paket in die ausgelieferte Ausgabe neu.
- Prüfe die Browser-Konsole nach Navigation und relevanter Interaktion.
Projektgebundene Module liegen außerhalb des portablen Contracts. Sie sind ausschließlich auf der Seite Nicht unterstützte projektgebundene Module dokumentiert; die Standard-Compliance liefert UNSUPPORTED und die Standard-CI schlägt fehl.