Campo
Un parámetro, propiedad u opción, con su tipo y su valor por defecto.
El componente más usado que a un tema de documentación le falta: un parámetro de la API, con más explicación de la que cabe en una fila de tabla.
Uso
showRepoboolean = falseFuerza un segmento de repositorio con un solo repositorio.
API
Props
| Prop | Tipo | Por defecto | Notas |
|---|---|---|---|
name | string | — | El nombre del parámetro, en monoespaciada |
type | string | — | Dibujado a su lado, en monoespaciada |
default | string | — | Alineado a la derecha, como = value |
required | boolean | false | Dibuja un distintivo en vez de un valor por defecto |
Slots
| Slot | Qué va dentro |
|---|---|
default | La descripción, como Markdown |
Notas
Una lista de definiciones sería la elección semántica y aquí es la equivocada: el
nombre, el tipo, el valor por defecto y si es obligatorio son cuatro cosas
distintas, y <dt> les da un único hueco entre todas.
Una tabla sigue siendo la mejor opción para una lista larga de campos de una línea — véase Fuentes, donde ocho campos están para compararse de un vistazo en vez de leerse uno a uno.
¿Le ha resultado útil esta página?