Files
ui/docs/content/3.components/breadcrumb.md
2024-07-17 15:44:38 +02:00

1.5 KiB

description, links
description links
A list of links that indicate the current page's location within a navigational hierarchy.
label icon to
GitHub i-simple-icons-github https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Breadcrumb.vue

Usage

Use the items prop as an array of objects with the following properties:

  • label?: string{lang="ts-type"}
  • icon?: string{lang="ts-type"}
  • avatar?: AvatarProps{lang="ts-type"}
  • slot?: string{lang="ts-type"}

You can also pass any property from NuxtLink component such as to, target, etc.

:component-example{name="breadcrumb-example"}

::tip A span will be rendered instead of a link when the to property is not defined. ::

Separator

Use the separator-icon prop to customize the Icon between each item. Defaults to i-heroicons-chevron-right-20-solid.

:component-example{name="breadcrumb-separator-example"}

::tip You can customize this icon globally in your app.config.ts under ui.icons.chevronRight key. ::

Examples

With separator slot

Use the #separator slot to customize the separator between each item.

:component-example{name="breadcrumb-separator-slot-example"}

With custom slot

Use the slot property to customize a specific item.

:component-example{name="breadcrumb-custom-slot-example"}

API

Props

:component-props

Slots

:component-slots

Theme

:component-theme