Skip to content

Breadcrumb - AvBreadcrumb

✨ Introduction

The AvBreadcrumb guides users through the different levels of your application.

The breadcrumb is a secondary navigation system that allows users to see where they are on the site they are visiting.

🏗️ Structure

It consists of the following elements:

  • a link to the root of the site (home page) - mandatory;
  • links to pages separating the root of the site from the current page - mandatory if the site hierarchy has more than one level;
  • the current page, the only non-clickable element - mandatory.

🏷️ Props

NameTypeDefaultMandatoryDescription
idstringbreadcrumb-${crypto.randomUUID()}The unique identifier for the breadcrumb element.
links{ to?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined; text: string }[] | undefinedundefinedA table of objects representing the links in the breadcrumb. Each object can have a ‘text’ property and, optionally, a ‘to’ property for routes.
navigationLabelstringundefinedDisplayed label on the breadcrumb nav tag.
showBreadcrumbLabelstringundefinedDisplayed breadcrumb button label.

🔊 Events

None.

🎨 Slots

None.

🚀 Storybook demos

You can find examples of use and demo of the component on its dedicated Storybook page.

💡 Examples of use

vue
<template>
  <AvNavigation :nav-items="navItems" />
</template>