Pular para o conteúdo
Estrutura

DescriptionList

/componentes/description-list.mdmarkdown cru, para quem lê com agent em vez de olho

Folha de detalhes

Rastreio
BR482915736
Postagem
05/08/2026
Entrega
09/08/2026
Situação
Entregue
Frete
R$ 24,80

Na própria caixa

Plano
Equipe
Assentos
12 de 15
Renova em
01/12/2026
Importar
import { DescriptionList } from '@rivocode/ui'

Quando usar

Pares de rótulo e valor, na marcação que já existe para isso: <dl>.

É a folha de detalhes de toda listagem (cliente, data do pedido, vencimento, valor) que cada tela montava com um par de <span> num flex. Aqui o leitor de tela ouve "termo, definição" em vez de dois textos soltos, e as linhas saem divididas pelo mesmo fio.

Vive bem dentro de Sheet e Dialog de detalhes, e ao lado de um Separator quando a folha tem mais de um bloco.

Na própria caixa

variant="boxed" põe a lista numa caixa com borda, canto e fundo de superfície. É o resumo embaixo de um Result e o detalhe solto numa página, onde não há cartão em volta. Dentro de Card, Sheet ou Dialog, fique no padrão plain: borda dentro de borda vira moldura dupla.

<DescriptionList variant="boxed">
  <DescriptionItem label="Plano">Equipe</DescriptionItem>
  <DescriptionItem label="Renova em">01/12/2026</DescriptionItem>
</DescriptionList>

As partes

DescriptionItem é uma linha: label de um lado, filho do outro. O valor aceita o que for: Badge para situação, tabular-nums para número de pedido, Clipboard para o que a pessoa vai levar embora, e dinheiro pelo currency, com o valor exato: a folha de detalhes é onde a pessoa confere o centavo. O rótulo não encolhe; valor comprido quebra do lado dele.

Quando não usar

Para muitos registros com as mesmas colunas, use DataTable: a folha de detalhes descreve uma coisa só, e repetir uma DescriptionList por registro perde a ordenação, a busca e a comparação de uma linha com a outra.

Para o número de painel com variação e tendência, o Stat diz mais que um par de rótulo e valor. E o valor que a pessoa corrige ali mesmo, sem abrir formulário, é Editable.

No React Native

Traduz: o @rivocode/ui-native exporta DescriptionList - as bordas entram por Children: a utility de divisória do Tailwind não existe no RN; variant="boxed" com o mesmo nome e a mesma caixa do web. A API não é a mesma do web (no nativo tudo é controlado), e a tabela de paridade diz o que muda peça a peça.

API

PropTipoPadrão
variant

`plain` e so as linhas, para dentro de um cartao que ja tem borda.

"boxed" | "plain""plain"

Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.

@rivocode/ui, 149 peças no catálogo. Esta página é gerada dos mesmos arquivos que alimentam o design system, então ela não envelhece sozinha.

Feito por RivoCode.