Navegação

VBreadcrumb

Componente7 exemplos5 propsA2UI · Breadcrumb

Trilha de navegação hierárquica que mostra onde o usuário está e permite voltar rapidamente aos níveis anteriores.

Importação
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'
</script>

Uso

Exemplo
<script setup lang="ts">

</script>

<template>
  
</template>

Playground

Os controles abaixo são gerados a partir das props declaradas em VBreadcrumb.types.ts; o código acompanha cada mudança.

Exemplos

Variantes, tamanhos e estados, extraídos das stories da biblioteca.

Default

Variação Padrão. Estado padrão do componente; use a aba Controls para experimentar as props ao vivo.

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  { label: 'Home', to: '/' },
  { label: 'Projects', to: '/projects' },
  { label: 'Marketing Site', to: '/projects/marketing' },
  { label: 'Assets' },
]
</script>

<template>
  <VBreadcrumb :items="items" />
</template>

Compact

Variação Compact. Props: variant="compact".

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  { label: 'Home', to: '/' },
  { label: 'Projects', to: '/projects' },
  { label: 'Marketing Site', to: '/projects/marketing' },
  { label: 'Assets' },
]
</script>

<template>
  <VBreadcrumb variant="compact" :items="items" />
</template>

With Icons

Variação Com ícones. Props: variant="icons".

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  { label: 'Home', to: '/', icon: 'home' },
  { label: 'Projects', to: '/projects', icon: 'folder' },
  {
    label: 'Marketing Site',
    to: '/projects/marketing',
    icon: 'document',
  },
  { label: 'Assets' },
]
</script>

<template>
  <VBreadcrumb variant="icons" :items="items" />
</template>

Overflow

Variação Overflow. Props: variant="overflow".

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  { label: 'Home', to: '/' },
  { label: 'Projects', to: '/projects' },
  { label: 'Marketing Site', to: '/projects/marketing' },
  { label: 'Assets' },
]
</script>

<template>
  <VBreadcrumb variant="overflow" :items="items" />
</template>

Sizes

Variação Tamanhos.

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  {
    label: 'Home',
    to: '/'
  },
  {
    label: 'Projects',
    to: '/projects'
  },
  {
    label: 'Marketing Site',
    to: '/projects/marketing'
  },
  {
    label: 'Assets'
  }
]
</script>

<template>
  <div style="display:grid;gap:16px;">
    <VBreadcrumb data-test-id="docs-breadcrumb-size-sm" size="sm" :items="items" />
    <VBreadcrumb data-test-id="docs-breadcrumb-size-md" size="md" :items="items" />
    <VBreadcrumb data-test-id="docs-breadcrumb-size-lg" size="lg" :items="items" />
  </div>
</template>

Custom Separator

Variação Personalizado Separator. Slots usados: #separator.

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const args = {
  size: 'md',
  variant: 'default',
  items: [
    {
      label: 'Home',
      to: '/'
    },
    {
      label: 'Projects',
      to: '/projects'
    },
    {
      label: 'Marketing Site',
      to: '/projects/marketing'
    },
    {
      label: 'Assets'
    }
  ]
}
</script>

<template>
  <VBreadcrumb v-bind="args">
    <template #separator><span>/</span></template>
  </VBreadcrumb>
</template>

Max Items

Variação Max itens. Props: variant="overflow", maxItems=3.

Ver código
vue
<script setup lang="ts">
import { VBreadcrumb } from 'vueui-nova-kit'

const items = [
  { label: 'Home', to: '/' },
  { label: 'Projects', to: '/projects' },
  { label: 'Marketing Site', to: '/projects/marketing' },
  { label: 'Assets' },
]
</script>

<template>
  <VBreadcrumb variant="overflow" :items="items" :max-items="3" />
</template>

Acessibilidade

  • <nav aria-label="Breadcrumb"> com lista ordenada interna
  • Foco visível em links e overflow
  • Teclado: Tab entre links, Enter ativa, Escape fecha overflow
  • Página atual com aria-current="page"

Estados

Default · Hover · Focus-visible · Pressed · Current page · Disabled

Motion

TriggerPropertyDurationEasing
Item hover/focusbackground/color100msease-out
Overflow openopacity/transform160msease-out
Pressedtransform scale(0.98)80msease-out

Respeitar prefers-reduced-motion.

Todas as transições respeitam prefers-reduced-motion e os tokens --v-duration-*.

Props

PropTipoDefaultDescrição
itemsVBreadcrumbItem[]——
sizeVBreadcrumbSize"md"—
variantVBreadcrumbVariant"default"—
maxItemsnumber4—
ariaLabelstring——

Events

EventoPayloadDescrição
@navigatepayload: { item: { label: string; href?: string; originalIndex: number }; index: number }—

Slots

SlotProps do slot
#separator—

Fonte: src/components/navigation/VBreadcrumb/VBreadcrumb.vue · tipos: src/components/navigation/VBreadcrumb/VBreadcrumb.types.ts