Champ
Un paramètre, une propriété ou une option, avec son type et sa valeur par défaut.
Le composant le plus utilisé qui manque à un thème de documentation : un paramètre d’API, avec plus d’explication qu’une ligne de tableau n’en contient.
Utilisation
showRepoboolean = falseForce un segment de dépôt même avec un dépôt unique.
API
Props
| Prop | Type | Par défaut | Remarques |
|---|---|---|---|
name | string | — | Le nom du paramètre, en mono |
type | string | — | Dessiné à côté, en mono |
default | string | — | Aligné à droite, sous la forme = value |
required | boolean | false | Dessine un badge au lieu d’une valeur par défaut |
Slots
| Slot | Ce qu’il contient |
|---|---|
default | La description, en Markdown |
Remarques
Une liste de définitions serait le choix sémantique, et c’est le mauvais ici : le
nom, le type, la valeur par défaut et le fait qu’il soit requis sont quatre
choses différentes, et <dt> ne leur donne qu’un seul emplacement à se partager.
Un tableau reste le meilleur choix pour une longue liste de champs d’une ligne — voir Sources, où huit champs sont faits pour être comparés d’un coup d’œil plutôt que lus un par un.
Cette page vous a-t-elle été utile ?