Skip to content

Commit

Permalink
docs: add description on options
Browse files Browse the repository at this point in the history
  • Loading branch information
Scrum committed Jul 26, 2018
1 parent c4983fc commit 80a4279
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,5 +112,17 @@ new Vue({
`
}).$mount('#app');
```
## Options
> An options object can also be passed into the plugin to specify your own template and rendering methods if desired. For example:
```js
import Vue from 'vue';
import VueBreadcrumbs from 'vue-2-breadcrumbs';

Vue.use(VueBreadcrumbs, {
template: '<nav class="breadcrumb" v-if="$breadcrumbs.length"> ' +
'<router-link class="breadcrumb-item" v-for="(crumb, key) in $breadcrumbs" :to="linkProp(crumb)" :key="key">{{ crumb | crumbText }}</router-link> ' +
'</nav>'
});
```

0 comments on commit 80a4279

Please sign in to comment.