@craydel/craydel-breadcrumbs

CraydelBreadcrumbs

Installation

Get the latest version by NPM:

$ npm i @craydel/craydel-breadcrumbs

Register Plugin

If you use the plugin API, the component will be registered as a global component just like when including it with the script tag, but you won't need to re-register it through the components property in your own components.

Create the plugin file e.g craydel-components.js file.

// craydel-components.js
import Vue from 'vue'
import CraydelBreadcrumbs from '@craydel/craydel-breadcrumbs/src/CraydelBreadcrumbs.vue'

const Components = {
  CraydelBreadcrumbs,
};

Object.keys(Components).forEach(name => {
  Vue.component(name, Components[name]);
});

export default Components;

Next reference the plugin file in your nuxt.config.js

// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
plugins: [
  '~/plugins/craydel-components.js'
]

Props

Name	Type	Default	Description
items	array	[]	An array of objects for each breadcrumb. Will look for a text, disabled and href keys.

 

Usage

An example showing the breadcrumbs.

<craydel-breadcrumbs
        :items="items"
></craydel-breadcrumbs>

data() {
  return {
    items: [
      {
        text: 'Home',
        disabled: false,
        href: '/',
      },
      {
        text: 'About Us',
        disabled: false,
        href: '/about',
      },
      {
        text: 'Our Team',
        disabled: true,
        href: '',
      }
    ]
  }
}