vue-2-breadcrumbs
breadcrumbs
Vue breadcrumbs builds on the official vue-router package to provide simple breadcrumbs. Demo
Support
- Support Nuxjs (example)
- Support SSR
- Setting parent route without need to actually nest it in children array
- Customized template
- Dynamic breadcrumbs
- Dynamic parent
- Dynamic label
- Shorthand labeling (
breadcrumb: 'Page Label'
) - Sub-routing
Install
$ npm install vue-2-breadcrumbs
Note: This project is compatible with node v10+
Usage
import Vue from 'vue';
import VueBreadcrumbs from 'vue-2-breadcrumbs';
import App from './App.vue';
Vue.use(VueBreadcrumbs);
Note: After that
<Breadcrumbs/>
component would be at your disposal.
Meta in router
import Vue from 'vue';
import VueRouter from 'vue-router';
Vue.use(VueRouter);
const router = new VueRouter({
routes: [
{
path: '/',
name: 'Home',
component: { template: '<h2>Home</h2>' },
meta: {
breadcrumb: 'Home'
}
},
{
path: '/params',
name: 'Params',
component: { template: '<h2>Params</h2>' },
meta: {
breadcrumb: routeParams => `route params id: ${routeParams.id}`
}
},
{
path: '/context',
name: 'Context',
component: { template: '<h2>Context</h2>' },
meta: {
breadcrumb() {
const { name } = this.$route;
return `name "${name}" of context route`;
}
}
},
{
path: '/parent',
component: { template: '<router-view/>' },
meta: {
breadcrumb: {
label: 'Parent to Params',
parent: 'Params'
}
},
{
name: 'dynamic-parent',
path: '/dynamic-parent',
component: { template: '<h2>Dynamic Parent</h2>' },
meta: {
breadcrumb() {
const { name } = this.$route;
return {
label: name,
parent: 'settings'
};
}
}
}
]
});
Options
An options object can also be passed into the plugin to specify your own template and rendering methods if desired. For example:
import Vue from 'vue';
import VueBreadcrumbs from 'vue-2-breadcrumbs';
Vue.use(VueBreadcrumbs, {
template:
' <nav v-if="$breadcrumbs.length" aria-label="breadcrumb">\n' +
' <ol class="breadcrumb">\n' +
' <li v-for="(crumb, key) in $breadcrumbs" v-if="crumb.meta.breadcrumb" :key="key" class="breadcrumb-item active" aria-current="page">\n' +
' <router-link :to="{ path: getPath(crumb) }">{{ getBreadcrumb(crumb.meta.breadcrumb) }}</router-link>' +
' </li>\n' +
' </ol>\n' +
' </nav>'
});
Dependencies
@ava/babel: ^1.0.1@ava/typescript: ^1.1.1@commitlint/cli: ^11.0.0@commitlint/config-angular: ^11.0.0@rollup/plugin-node-resolve: ^11.1.0@vue/compiler-sfc: ^2.7.14@vue/test-utils: ^1.1.2ava: ^3.15.0clinton: ^0.14.0conventional-changelog-cli: ^2.1.1husky: ^4.3.8lint-staged: ^10.5.3nyc: ^15.1.0rimraf: ^3.0.2rollup: ^2.38.0rollup-plugin-terser: ^7.0.2rollup-plugin-typescript2: ^0.29.0tslint: ^6.1.3typescript: ^4.1.3vue: ^2.6.12vue-router: ^3.5.1vue-template-compiler: ^2.6.12