Componentes
Description List
betaPares de rótulo e valor, para o resumo de um registro. É leitura, não formulário.
Ainda não é estável porque Pendência editorial: oQueE, quandoUsar, quandoNaoUsar; Rota não varrida pelo sensor. Ausência de medição não é aprovação. O contrato de maturidade explica o que cada requisito exige.
@voxmente/ui/components/ui/description-list
Playground
- Escola
- Vila Nova
- Turma
- 7º ano B
- Coordenador
- Marina Costa
- Justificativa
- Acesso temporário durante a migração de turmas.
<DescriptionList>
<DescriptionListItem label="Escola">Vila Nova</DescriptionListItem>
<DescriptionListItem label="Turma">7º ano B</DescriptionListItem>
<DescriptionListItem label="Coordenador">Marina Costa</DescriptionListItem>
<DescriptionListItem label="Justificativa">
Acesso temporário durante a migração de turmas.
</DescriptionListItem>
</DescriptionList>Uso
Anatomia de toda superfície de detalhe: ficha da escola, cabeçalho do chamado, resumo de uma fatura.
- Escola
- Vila Nova
- Turma
- 7º ano B
- Coordenador
- Marina Costa
- Alunos
- 32
Colunas
`columns` aceita 1, 2 ou 3. Mais colunas cabem em ficha densa; uma coluna serve para um resumo lido de cima a baixo.
- Trilha
- Leitura fluente
- Sessões
- 6
- Concluídas
- 4
Item de linha inteira
`wide` ocupa a linha inteira — para observações, justificativas de acesso e outros valores que não cabem numa coluna.
- Solicitante
- Marina Costa
- Papel
- Coordenação
- Justificativa
- Acesso temporário para acompanhar a migração de turmas da Escola Vila Nova durante o mês de setembro.
Valor ausente
Sem `children`, o item mostra um travessão — não deixe o rótulo sozinho, sem sinal de que o valor foi checado e está de fato vazio.
- Escola
- Vila Nova
- Telefone
- —
Referência da API
Extraída do TypeScript de @voxmente/ui a cada build. Se divergir do código, o código mudou.
DescriptionList
| Prop | Tipo | Padrão |
|---|---|---|
| columns | 1 | 2 | 3 | 2 |
Também aceita as props de React, incluindo className e os atributos de DOM.
DescriptionListItem
| Prop | Tipo | Padrão |
|---|---|---|
| label* | string | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<...> | null | — |
| wide | boolean | false |
Também aceita as props de React, incluindo className e os atributos de DOM.
Pendência editorial: o que é, quando usar, quando não usar, acessibilidade, componentes relacionados, exemplo em contexto de produto. A lacuna aparece aqui em vez de ser preenchida com orientação inventada.
Origem do dado
- Demonstrações e playground: componente real de @voxmente/ui
- Referência da API: TypeScript do pacote
- Cor, espaçamento e raio das demonstrações: tokens de theme.css