isy / vue-toc

A table of contents component for vue.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

vue-toc Build Status

Vue.js component that automatically generates a table of contents.

Install

$ npm install vue-toc

Register the component

import Vue from 'vue'
import VueToc from 'vue-toc'

Vue.component('vue-toc', VueToc)

Options

key description default val
target Specify the location of the heading none String
h2Class Specify css class in table of contents(h2) toc-2 String
h3Class Specify css class in table of contents(h3) toc-3 String

※Please be sure to attach an ID to the h2 and h3 tags for in-page links

About

A table of contents component for vue.js


Languages

Language:Vue 76.5%Language:JavaScript 14.6%Language:HTML 8.8%