Pular para o conteúdo
Navegação

Breadcrumb

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

Caminho

Dobrado

Importar
import { Breadcrumb } from '@rivocode/ui'

Quando usar

O caminho até onde a pessoa está.

Encolhe sozinho: passando de max, o meio vira reticência, e ficam a primeira migalha e as max - 1 últimas (nunca menos que a última). A reticência só aparece quando esconde ao menos uma migalha. No celular sobram as duas últimas migalhas, porque caminho comprido rola para fora da tela e ninguém lê o começo.

O teto se chama max, o mesmo nome que Indicator, AvatarGroup e TagsInput usam para a mesma ideia.

O caminho entra por items, uma lista de Crumb ({ label, href }, com o href de fora na última, que é onde a pessoa já está):

const trilha: Crumb[] = [
  { label: 'Turmas', href: '/turmas' },
  { label: 'Turma 3º B' },
]

A última não é link e leva aria-current="page".

Com o router

Migalha com href é um <a href>, e num app com router cada clique recarrega a página inteira. Passe o link do router em render, a mesma forma do SidebarMenuItem e do Link: a migalha veste o elemento com o desenho dela, e quem navega é o router. Com render, o href fica opcional.

import { NavLink } from 'react-router'

const trilha: Crumb[] = [
  { label: 'Turmas', render: <NavLink to="/turmas" /> },
  { label: 'Turma 3º B' },
]

Quando não usar

Para mostrar em que etapa de um fluxo a pessoa está (cadastro, checkout, matrícula), use Steps: a trilha diz de onde ela veio na hierarquia de páginas, e o passo diz o que falta para terminar. Etapa não é página-mãe.

Em sistema de um nível só, a trilha repete o título da página e o item marcado na Sidebar, e sobra. E no topo de rota ela entra pelo slot breadcrumb do PageHeader, e não solta acima dele.

No React Native

Não porta. O caminho até onde a pessoa está é, no celular, o botão de voltar do router mais o título da tela. Desenhar uma trilha por cima disso duplica a navegação e come a largura que o título precisa.

API

PropTipoPadrão
itemsobrigatória0.4.0Crumb[]sem padrão
labels

Os textos da peca, para trocar o idioma: `navigation` e o nome da regiao, "Caminho" sem ele.

Partial<BreadcrumbLabels>sem padrão
max

Quantas migalhas cabem antes de o meio virar reticencia: dobrada, a trilha mostra a primeira e as `max - 1` ultimas, e nunca menos que a ultima.

number4

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.