Feld
Ein Parameter, eine Eigenschaft oder eine Option, mit Typ und Standard.
Die meistgenutzte Komponente, die einem Dokumentations-Theme fehlt: ein API-Parameter, mit mehr Erklärung, als in eine Tabellenzeile passt.
Verwendung
showRepoboolean = falseErzwingt ein Repository-Segment auch bei einem einzelnen Repository.
API
Props
| Prop | Typ | Standard | Anmerkungen |
|---|---|---|---|
name | string | — | Der Name des Parameters, in Mono |
type | string | — | Daneben gezeichnet, in Mono |
default | string | — | Rechtsbündig, als = value |
required | boolean | false | Zeichnet ein Badge statt eines Standards |
Slots
| Slot | Was hineingehört |
|---|---|
default | Die Beschreibung, als Markdown |
Anmerkungen
Eine Definitionsliste wäre die semantische Wahl und ist hier die falsche: Der
Name, der Typ, der Standard und ob das Feld erforderlich ist, sind vier
verschiedene Dinge, und <dt> gibt ihnen allen zusammen einen einzigen Slot.
Für eine lange Liste einzeiliger Felder bleibt eine Tabelle die bessere Wahl — siehe Quellen, wo acht Felder auf einen Blick verglichen und nicht nacheinander gelesen werden sollen.
War diese Seite hilfreich?