BreadcrumbsReady

Breadcrumbs show the navigation path users followed to arrive at the current page, making it simple to return to earlier sections.

Open in new window
Open in new window
View RTL
<script setup lang="ts">
const route = useRoute()
const breadcrumbs = ref<BreadcrumbsType>({
  category: 'common.breadcrumbs.label',
  items: [
    {
      // @ts-expect-error - translation string
      label: 'Breadcrumbs 1',
      url: { path: route.path, query: { consultation_id: 1 } },
    },
    {
      // @ts-expect-error - translation string
      label: 'Breadcrumbs 2',
      url: { path: route.path, query: { consultation_id: 2 } },
    },
  ],
})

useBreadcrumbs().mutate(breadcrumbs.value)
</script>

<template>
  <TheBreadcrumbs />
</template>

Usage

This section includes guidelines for designers and developers about the usage of this pattern in different contexts.

Do

  • Use breadcrumbs to display a hierarchy of pages and improve navigation.
  • Include breadcrumbs to represent a hierarchy with multiple parent pages.
  • Show the current page in the breadcrumbs if its title is not visible elsewhere on the page.

Don’t

  • Avoid using breadcrumbs if the page only has a single parent page. Use a Link instead.
  • Don't use breadcrumbs to indicate progress in a task.
  • Prevent redundancy. Exclude the current page from breadcrumbs if its title is already displayed on the page.

Integration

This product pattern is currently only available to use in the New Frontend for Provet Cloud (using Vue & Nuxt).


Troubleshooting

If you experience any issues while using this pattern, please ask for support in the #vet-frontend Slack channel.


Was this page helpful?

YesNo
Send feedback

We use this feedback to improve our documentation.

 
Edit page