0.1.1 • Published 5 years ago

vue-catalog v0.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

vue-catalog

从html文章内容中提取目录结构,基于vue开发

安装

npm install --save vue-catalog
# or
yarn add vue-catalog

使用方法

import {catalog, getCatalog} from 'vue-catalog';
export default {
  name: 'app',
  data () {
    return {
      catalog: {
        levels: [], // 有层级关系的目录结构数组
        noLevels: [], // 没有层级关系的目录结构数组
      }
    }
  },
  mounted () {
    // 获取文章目录结构
    let {levels, noLevels} = getCatalog(this.$refs.content)
    this.catalog = {
      levels,
      noLevels
    }
  },
  components: {
    catalog 
  }
}
  • getCatalog:获取目录结构方法,有一个参数,要提取目录的dom节点对象或者节点ID;

  • catalog: 目录显示插件,主要参数如下:

参数名类型说明默认
listArray要显示的目录结构(带层级),通过getCatalog提取
sequenceArray要显示的目录结构(不带层级),如果未定义,则使用list中转换
catalogItemClassNameString目录结构列表项class类名catalog-item
curItemClassNameString当前浏览的目录项class类名catalog-item-cur
isShowCurBoolean是否为正在浏览的目录项添加类名true