API Documentation

DruxtBreadcrumb

breadcrumb

Modules

DruxtBreadcrumb

Renders a list of breacrumbs based on the active route.

Typedefs

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

PropsData : object

Provides propsData for use in the Wrapper component.

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

DruxtBreadcrumb

Renders a list of breacrumbs based on the active route.

Example

<DruxtBreadcrumb />

.fetchCrumbs()

Fetch Crumbs

Kind: instance method of DruxtBreadcrumb


.props

Kind: static property of DruxtBreadcrumb


.home : boolean

Show home crumb?

Kind: static property of props
Default: true
Example

<DruxtBreacrumb :home="false" />

.computed

Kind: static property of DruxtBreadcrumb


.crumbs

Kind: static property of computed
Properties

NameTypeDescription
crumbsArray.<objects>The Breadcrumbs.

.watch

Kind: static property of DruxtBreadcrumb


.$route()

Updates crumbs on Route change.

Kind: static method of watch


.druxt

DruxtModule settings

Kind: static property of DruxtBreadcrumb


.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the Druxt Wrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.slots() ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

The default slot renders crumbs as a list of NuxtLink's.

Kind: static method of druxt
Returns: ScopedSlots - The Scoped slots object.


.fetch()

The Nuxt Fetch hook.

Fetches the breadcrumbs.

Kind: static method of DruxtBreadcrumb


ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

Kind: global typedef
Example

[
  'DruxtBreadcrumb[Default]',
]

Example

[
  'DruxtBreadcrumbDefault',
]

PropsData : object

Provides propsData for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
crumbsArray.<objects>The Breadcrumbs.
valueArray.<objects>The Breadcrumbs value.

Example

{
  crumbs: [{
    text: 'Home',
    to: '/',
  }],
  value: [{
    text: 'Home',
    to: '/',
  }],
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
defaultfunctionCrumbs as a list of NuxtLink's.

Example (DruxtBreadcrumbDefault.vue)

<template>
  <div>
    <slot />
  </div>
</template>