PageHeader
Padrão
Projetos
Só o título
Ajustes
import { PageHeader } from '@rivocode/ui'Quando usar
O topo que toda rota reescreve um pouco diferente: trilha, título, descrição e as ações da tela, na mesma hierarquia em todas as páginas.
<PageHeader
title="Pacientes"
description="Quem tem consulta marcada ou passou pela clínica nos últimos 12 meses."
breadcrumb={
<Breadcrumb items={[{ label: 'Clínica', href: '/' }, { label: 'Pacientes' }]} />
}
actions={
<>
<Button variant="secondary">Exportar</Button>
<Button>Novo paciente</Button>
</>
}
/>
O título sai num <h1> por padrão. Cabeçalho de página é o topo dela, e
começar a página num h2 deixa um buraco que o leitor de tela sente. A
trilha entra pelo slot breadcrumb, com o Breadcrumb da casa; as ações
entram por actions e ficam à direita, quebrando de linha no estreito antes
de espremer o título.
No celular a caixa das ações também encolhe e quebra por dentro: um
ToggleGroup de período ao lado de um Switch desce para a linha de baixo, e
a página não rola de lado. Na mesa ela continua inteira, sem encolher. Não
precisa mais de classNames={{ actions: "shrink min-w-0" }}.
A description sai num div, e não num <p>: cabe uma frase, e cabe também
um bloco — dois parágrafos, um Badge ao lado do texto — sem virar HTML
inválido. O tamanho e a cor do texto continuam os da frase.
Quando o cabeçalho não é o topo
titleAs baixa o título para h2 ou h3 sem mexer no desenho. Nível
semântico e tamanho visual são coisas diferentes, e o título continua o mesmo
text-2xl em qualquer nível.
<PageHeader titleAs="h2" title="Agenda da semana" />
Use quando o PageHeader não é o começo da página: a aplicação já tem o h1
no shell, a peça está dentro de uma região, ou é um exemplo dentro de outra
página (como os desta aqui, que saem em h2 justamente por isso). Dois h1
na mesma página não dão erro em lugar nenhum: quem navega por título de nível
1 é que cai no lugar errado.
Quando não usar
Para o esqueleto da aplicação inteira (cabeçalho fixo, barra lateral,
landmarks), use AppShell: o PageHeader é o topo de cada rota, dentro dele, e
não o cabeçalho da aplicação.
Título de seção no meio da página é Heading, e não outro PageHeader: trilha
e ações por seção repetem o que o topo já disse. E o título de um cartão mora no
CardHeader, com CardTitle.
No React Native
Traduz: o @rivocode/ui-native exporta PageHeader - title, description, badge e actions como props; classNames com as cinco partes 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
| Prop | Tipo | Padrão |
|---|---|---|
titleobrigatória0.4.0O nome da tela. | ReactNode | sem padrão |
actions0.4.0O que da para fazer daqui: botao de criar, exportar, filtrar. | ReactNode | sem padrão |
breadcrumb0.4.0A trilha ate aqui: o `Breadcrumb` da casa. | ReactNode | sem padrão |
classNamesClasse por parte: `row`, `heading`, `title`, `description`, `actions`. | Partial<Record<"actions" | "description" | "heading" | "row" | "title", string>> | sem padrão |
description0.4.0Uma frase sobre o que a tela mostra. | ReactNode | sem padrão |
titleAsEm que nivel o titulo sai. | "h1""h2""h3" | "h1" |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.