Breadcrumb

Breadcrumb provides contextual information about page hierarchy.

Download #


npx volt-vue add Breadcrumb

Import #


import Breadcrumb from '@/volt/Breadcrumb.vue';

Basic #

Breadcrumb requires a collection of menuitems as its model, the root item is defined with the home property.


<template>
    <div class="card flex justify-center">
        <Breadcrumb :home="home" :model="items" />
    </div>
</template>

<script setup lang="ts">
import Breadcrumb from '@/volt/Breadcrumb.vue';
import { ref } from 'vue';

const home = ref({
    icon: 'pi pi-home'
});
const items = ref([{ label: 'Electronics' }, { label: 'Computer' }, { label: 'Accessories' }, { label: 'Keyboard' }, { label: 'Wireless' }]);
</script>

Template #

Custom content can be placed inside the items using the item template. The divider between the items has its own separator template.


<template>
    <div class="card flex justify-center">
        <Breadcrumb :home="home" :model="items">
            <template #item="{ item }">
                <a class="cursor-pointer text-primary hover:text-color" :href="item.url">
                    <span :class="item.icon"></span>
                </a>
            </template>
            <template #separator>
                <span class="text-primary">/</span>
            </template>
        </Breadcrumb>
    </div>
</template>

<script setup lang="ts">
import Breadcrumb from '@/volt/Breadcrumb.vue';
import { ref } from 'vue';

const home = ref({ icon: 'pi pi-home' });
const items = ref([{ icon: 'pi pi-sitemap' }, { icon: 'pi pi-book' }, { icon: 'pi pi-wallet' }, { icon: 'pi pi-shopping-bag' }, { icon: 'pi pi-calculator' }]);
</script>

Router #

Items with navigation are defined with templating to be able to use a router link component, an external link or programmatic navigation.


<template>
    <div class="card flex justify-center">
        <Breadcrumb :home="home" :model="items">
            <template #item="{ item, props }">
                <router-link v-if="item.route" v-slot="{ href, navigate }" :to="item.route" custom>
                    <a :href="href" v-bind="props.action" @click="navigate">
                        <span :class="[item.icon, 'text-color']" />
                        <span class="text-primary font-semibold">{{ item.label }}</span>
                    </a>
                </router-link>
                <a v-else :href="item.url" :target="item.target" v-bind="props.action">
                    <span class="text-surface-700 dark:text-surface-0">{{ item.label }}</span>
                </a>
            </template>
        </Breadcrumb>
    </div>
</template>

<script setup lang="ts">
import Breadcrumb from '@/volt/Breadcrumb.vue';
import { ref } from 'vue';

const home = ref({
    icon: 'pi pi-home',
    route: '/overview'
});
const items = ref([{ label: 'Components' }, { label: 'Form' }, { label: 'InputText', route: '/inputtext' }]);
</script>