listtree

v1.2.10

Published

3 years ago

A longitudinal menu of unlimited list

Downloads

0High
0Medium
0Low

wulin1978

listtree —— vue无限级菜单

listtree 是基于vue2.x的无限级菜单插件，基本可以满足大部分纵列多级别菜单的需求，并且用户定义菜单样式的自由度非常高，具体到每一级别的菜单甚至每一个菜单分支的单独样式都可以自由定义，和自己写css样式没有任何区别。菜单前的小图标可以使用系统默认的图标，也可以使用阿里巴巴图标库和Font Awesome图标库里的图标，当然你也可以使用自己设计的png、arrow等格式的图标。

安装

npm install listtree -S

使用

在需要插入菜单的组件插入JS代码：

import Vue from 'vue'
import Listtree from 'listtree'
import listData from './listdata.json'

Vue.use(Listtree, {
  listData
})

/* $listClick 和 $listMouseOver 非必要
Vue.prototype.$listClick = (parameter) => {
  if (parameter !== undefined) {
    // 当点击菜单时你希望系统做的事情可以写在这里（比如路由跳转）
  }
}
Vue.prototype.$listMouseOver = (parameter) => {
  if (parameter !== undefined) {
    // 当鼠标经过菜单时你希望系统做的事情可以写在这里
  }
}
 */

在需要插入菜单的地方插入下面代码：

<div class="listtree"></div>

其中listdata.json是菜单的数据内容，下面讲参数时会具体说明。

参数

listtree 一共有9个参数：listData、open、openOnly、indent、arrow、arrowSize、arrowLeft、animation、eventArea，通过配置这9个参数可以使 listtree 适应不同类型的菜单需求，为了描述方便，这里假设你要插入本插件的组件为mytree.vue(建议用空组件来引入本插件，然后在需要使用本本插件的地方直接import该组件)

| 参数 | 属性 | 默认值 | 可能的值 | 描述 | | ---- | ------ | :------: | :-----: | ------- | | listData | 必选 | —— | —— | 包含了所有菜单分支中的必要数据，listData 中每个元素代表一个菜单分支，每个分支包含4个属性：name、icon、parameter、children | | open | 可选 | 1 | 0/1/数组 | open 控制各菜单分支的默认展开闭合状态，0表示所有菜单初始状态为闭合状态，1表示所有菜单初始状态为展开状态，如果open为数组，则数组中元素值控制可各级别菜单的默认状态。 | | openOnly | 可选 | 0 | 0/1 | openOnly控制菜单的展开方式，openOnly 为 1 的时候同级别菜单分支在同一时间只能展开一个分支，不同级别的分支互相不受影响。 | | indent | 可选 | 24 | —— | indent 控制上下级菜单缩进距离，单位为 px。当 indent 为 0 时，上下级菜单没有缩进，所有菜单分支左边对齐。| | arrow | 可选 | 1 | 0~10/数组 | arrow 控制每个菜单分支前面的箭头图标样式，插件自带10个箭头样式，也可以使用阿里巴巴图标库的图标和Font Awesome图标库图标，arrow 为0时表示不使用箭头。 | | arrowLeft | 可选 | —— | —— | arrowLeft 用来控制箭头图标的与边框的距离，单位为px。如果arrowLeft为正数表示与左边的距离为arrowLeft，如果arrowLeft为负数，表示箭头与右边款的距离为arrowLeft的绝对值。| | arrowSize | 可选 | —— | —— | arrowSize 用来控制箭头图标的尺寸，单位为px。如果没有设置该值，也可以通过设置样式lt-branch-arrow里的font-size来控制箭头尺寸。| | animation | 可选 | 1 | 0/1/2 | animation 控制插件是否使用动画以及使用哪种动画，值为 0 时表示不使用动画，值为 1 或 2 时表示插件展开和闭合时使用动画，目前插件支持2种动画形式。| | eventArea | 可选 | 'line' | 'line'/'content' | eventArea 控制鼠标点击或经过菜单分支某区域时触发事件，值为'line'时该区域为菜单分支所在行，值为'content'时该区域为菜单分支文字内容。|

1、listData [Array 必选]

listData 包含了各菜单分支中的必要数据，包括：菜单的标题内容（name），菜单分支对应的图标（icon），参数（parameter），以及子级菜单（children）。类似于下面这段代码：

[
  {
    "name": "一级目录一",
    "children": [
      {
        "name": "二级目录一",
        "parameter": "/erji"
      }
    ]
  },
  {
    "name": "一级目录二",
    "children": [
      {
        "name": "二级目录二",
        "icon": "iconfont icon-yousanjiao",
        "parameter": "/po"
      },
      {
        "name": "二级目录三",
        "parameter": "/pl"
      }
    ]
  }
]

菜单分支listData四个属性：

name [String 必选]：为菜单的文字内容；

parameter [String/Array/Object 可选]：当点击菜单时parameter会传递给外部组件，与菜单相关的一些数据（比如菜单分支对应的路由地址，在数据库中的id等）都可以放在 parameter 中，你可以在组件中通过创建 Vue.prototype.$listClick 函数接收 parameter 数据并做一些相关的操作；

icon [String 可选]：菜单分支前面的图标（和arrow表示的箭头图标不一样），可以使用阿里巴巴图标库的图标和Font Awesome图标库图标，icon的内容应该是阿里巴巴图标库或者Font Awesome图标库的图标样式。在使用这些图标之前需要先下载阿里巴巴图标库或者Font Awesome图标库的图标字体和css文件，然后在组件中引用该css文件，具体使用方法可以参考下面介绍的arrow图标的描述说明；

children [Array 可选]：菜单的子分支。

下面截图是 listtree 的一个典型例子：

2、open [Number/Array 1 可选]

open 控制各菜单分支的默认展开闭合状态

open等于 1 的时候，所有菜单分支均处于展开状态，该值为open的默认值；

open等于 0 的时候，所有菜单分支均处于闭合状态；

open为数组时，open内元素的值可以为1、0 或者 'always'，1 表示展开，2 表示闭合，'always' 表示一直展开（即不能被关闭）。菜单分支所处的状态与该菜单分支的级别对应的open的元素值相关。比如一级菜单分支状态与open第一个元素值对应，二级菜单分支状态与open第二个元素值对应，以此类推。当然你并不需要把所有级别的状态都写到open数组里，你只需要写前面几个，后面级别的菜单状态都和open最后一个元素保持相关。比如open等于 [1, 0] ，表示一级菜单状态为展开（因为第一个元素为1），二级菜单以及后面所有菜单分支均为闭合（open第二个元素也是最后一个元素为0）。又比如open等于 ['always',0,1]，表示一级菜单状态一直保持展开，二级菜单为闭合状态，从三级菜单开始后面所有菜单均为展开状态。

3、openOnly [Number 0 可选]

openOnly 为 1 的时候同级别菜单分支在同一时间只能展开一个分支，不同级别的分支互相不受影响。openOnly 为 1 的时候，除了open为'always'的所有分支初始状态均为闭合状态。

4、indent [Number 24 可选]

indent 可控制上下级菜单缩进距离，单位为 px。默认值为24px，当 indent 为 0 时，上下级菜单没有缩进，所有菜单分支左边对齐。

5、arrow [Number/Array 1 可选]

arrow 即箭头图标，它可以是数字，也可以是数组。当 arrow 为数字时，图标显示的是插件自带的图标样式，目前提供 1 到 10 十种样式。当图标为数组时，用户可以从阿里巴巴图标库或Font Awesome图标库选择图标，也可以使用png、icon等图片格式的图标。数组的第一个元素数据类型是字符串，指向菜单闭合时使用的图标。数组第二个元素可以是字符串也可以是number，当为字符串的时候它指向菜单展开时使用的图标，当为number时，表示菜单展开和闭合时使用同一个图标，但展开时图标顺时针旋转一个角度，这个角度的值即为数组第二个元素的值。

arrow 为数字时比较简单也好理解，下面我们举例详细说明下 arrow 为数组时的各种情况。

a 使用阿里巴巴图标库图标 我们假设你已经在阿里巴巴图标库创建了自己的项目并已经添加或上传了自己的图标，现在打开阿里巴巴图标库进入你的项目，选择 Font class，点击下载至本地，将其解压放到mytree.vue同一个文件夹下，当然你也可以直接复制使用在线链接就不需要下载到本地了，如下图：

mytree.vue 组件中的代码如下：

<template>
  <div class="hello">
    <div class="listtree"></div>
  </div>
</template>
<script>
import Vue from 'vue'
import Listtree from 'listtree'

Vue.use(Listtree, {
  listData: require('./data.json'),
  arrow: ['iconfont xxxxxxxxxxxxx', 'iconfont yyyyyyyyyyyyyy']
})
Vue.prototype.$listClick = (parameter) => {
  if (parameter !== undefined) {
    ……
  }
}
</script>
<style>
@import url("./xxxxxxxx/iconfont.css");
</style>

xxxxxxxxxxxxx 为闭合时的图标，yyyyyyyyyyyyyy 为展开时的图标，iconfont不可省略。xxxxxxxx/iconfont.css 为下载的阿里巴巴图标库中的css文件，如果使用在线链接的话直接把url里面的内容换成在线链接的地址就可以了

当然上面代码中arrow也可以替换成：arrow: ['iconfont xxxxxxxxxxxxx', 90] ，此时表示菜单展开和闭合时图标都是 xxxxxxxxxxxxx，只是展开时图标顺时针旋转90度

b 使用Font Awesome图标库 打开Font Awesome网站并下载最新版Font Awesome，将Font Awesome解压到mytree.vue同一个文件夹，mytree.vue 代码如下：

<template>
  <div class="hello">
    <div class="listtree"></div>
  </div>
</template>
<script>
import Vue from 'vue'
import Listtree from 'listtree'

Vue.use(Listtree, {
  listData: require('../static/data.json'),
  arrow: ['fa xxxxxxxxxxxxx', 'fa yyyyyyyyyyyyyy']
})
Vue.prototype.$listClick = (parameter) => {
  if (parameter !== undefined) {
    ……
  }
}
</script>
<style>
@import url("./font-awesome-4.7.0/css/font-awesome.min.css");
</style>

xxxxxxxxxxxxx 为闭合时的图标，yyyyyyyyyyyyyy 为展开时的图标，fa不可省略。代码中arrow也可以替换成：arrow: ['fa xxxxxxxxxxxxx', 90] ，此时表示菜单展开和闭合时图标都是 xxxxxxxxxxxxx，只是展开时图标顺时针旋转90度

c 使用png、arrow等图片格式作为图标 建议将图片存放在static文件夹里，mytree.vue 代码如下：

<template>
  <div class="hello">
    <div class="listtree"></div>
  </div>
</template>
<script>
import Vue from 'vue'
import Listtree from 'listtree'

Vue.use(Listtree, {
  listData: require('../static/data.json'),
  arrow: ['../static/xxxxxxxxxxxxx', '../static/yyyyyyyyyyyyy']
})
Vue.prototype.$listClick = (parameter) => {
  if (parameter !== undefined) {
    ……
  }
}
</script>
<style>
</style>

xxxxxxxxxxxxx 为闭合时的图标，yyyyyyyyyyyyyy 为展开时的图标。代码中arrow也可以替换成：arrow: ['../static/xxxxxxxxxxxxx', 90] ，此时表示菜单展开和闭合时图标都是 ../static/xxxxxxxxxxxxx，只是展开时图标顺时针旋转90度

如果不想在菜单里使用箭头图标，可以将arrow的值直接设为0就可以了。

注：权重大小 listData中的arrow > 参数arrow，如果你设置了参数arrow，同时某个分支对应的listData又设置了arrow，那么该分支图标将显示listData中设置的arrow

6、arrowLeft [Number 可选]

arrowLeft 控制箭头图标的左边距，单位为px，如果 arrowLeft 值为负数，箭头图标将出现在菜单的右侧，箭头图标与右边框的距离为 arrowLeft 的绝对值。

7、arrowSize [Number 可选]

arrowSize 控制箭头图标的尺寸，单位为px，该参数没有默认值，如果没有设置该值，则图标大小会由与之最近的fong-size控制，因为这里的图标本质上也是一种字体（用图片作为图标的除外），所以你也可以通过设置样式lt-branch-arrow中的font-size的值来控制箭头图标尺寸。但当图标为图片时，arrowSize和font-size对图标无效。

8、animation [Number 1 可选]

animation 控制插件是否使用动画，值为 0 时表示不使用动画，值为 1 或 2 时表示插件展开和闭合时使用动画，目前插件支持2种动画形式。默认值为1。

9、eventArea [String "line" 可选]

事件区域，eventArea有2个值分别为'line'和'content'，值为'line'时表示鼠标点击或经过菜单分支所在行时触发Vue.prototype.$listClick和Vue.prototype.$listMouseOver；值为'content'时表示鼠标点击或经过菜单分支文字内容时触发Vue.prototype.$listClick和Vue.prototype.$listMouseOver

listtree 样式命名规则

在 listtree 插件中每一级菜单及其图标都有自己的样式，如果你了解了这些样式的命名规则，你就可以为不同级的菜单定义不同的样式，甚至可以为任何一个菜单分支定义不同的样式

1、菜单分支的index

一级菜单index为自然数，从 1 开始分配，按照从上到下的顺序，每加一个一级分支index加1；
除一级菜单以外的菜单index为其父级菜单index加“-”再加一个自然数，该自然数也是从 1 开始分配，按照从上到下的顺序，每加一个分支该自然数加1（比如：2-1-3代表的是第二个一级分支下的第一个子分支下的第三个子分支）;
父级菜单不同的分支，其后面加的自然数互相不影响，也就是说每个菜单分配其子菜单的index时，其后面加的自然数都是从 1 开始。

简单来说菜单分支的index就是类似于这样的： 2-1-5-3-2，其中“2-1-5-3”为该分支父级分支的index

2、菜单分支及其图标的 ID

菜单分支的 ID 等于 "lt-branch_" 加上该分支的index，该菜单分支所对应的图标 ID 等于 "lt-branch-arrow_" 加上该分支的index。

3、不同级别菜单分支的 className

不同级别菜单分支的 className 等于 "lt-branch_level_" 加上该菜单的级别。不同级别菜单分支对应的图标的 className 等于 "lt-branch-arrow_level_" 加上该菜单的级别。如果一个菜单分支没有子级菜单，该类菜单还拥有样式："lt-branch_level_0"，该类菜单的图标拥有样式："lt-branch-arrow_level_0"。lt-branch-arrow_level_0 和表示级别分支的 className 可同时存在。如下：

lt-branch_level_1         >>>>>>      一级菜单分支样式
lt-branch_level_2         >>>>>>      二级菜单分支样式
lt-branch_level_3         >>>>>>      三级菜单分支样式
……

lt-branch-arrow_level_1    >>>>>>      一级菜单分支图标样式
lt-branch-arrow_level_2    >>>>>>      二级菜单分支图标样式
lt-branch-arrow_level_3    >>>>>>      三级菜单分支图标样式
……

lt-branch_level_0         >>>>>>      没有子级的菜单分支的样式
lt-branch-arrow_level_0    >>>>>>      没有子级的菜单分支图标的样式

4、菜单分支被点击后的 className

某个菜单分支被点击后会增加一个样式："lt-branch_active"，这个被点击的分支父级分支也会增加一个样式："lt-branch_active_parent"，同时这个被点击的分支所有祖先分支都会增加active样式，这些active样式名目规则是：如果祖先分支是一级分支，增加的样式名为："lt-branch_level_1_active"，如果祖先分支是二级分支，增加的样式名为："lt-branch_level_2_active" …… ，以此类推。lt-branch_active 和代表级别的active样式可同时存在，比如：点击一个二级分支，该二级分支会同时包含lt-branch_level_2_active 和 lt-branch_active 2个样式。同样，lt-branch_active_parent 和代表级别的active样式也可同时存在。

同理，某个菜单分支被点击后其对应的图标也会增加一个样式："lt-branch-arrow_active"，这个被点击的分支父级分支对应的图标增加一个样式："lt-branch-arrow_active_parent"，其祖先分支对应的图标增加的样式为："lt-branch-arrow_level_1_active"、 "lt-branch-arrow_level_2_active"、 "lt-branch-arrow_level_3_active" …… 。

lt-branch_active                 >>>>>>       当前被点击的菜单分支的样式
lt-branch-arrow_active            >>>>>>       当前被点击的菜单分支图标的样式

lt-branch_active_parent          >>>>>>       当前被点击的菜单分支父级分支的样式
lt-branch-arrow_active_parent     >>>>>>       当前被点击的菜单分支父级分支图标的样式

lt-branch_level_1_active         >>>>>>       当前被点击的菜单分支祖先一级分支的样式
lt-branch_level_2_active         >>>>>>       当前被点击的菜单分支祖先二级分支的样式
lt-branch_level_3_active         >>>>>>       当前被点击的菜单分支祖先三级分支的样式
……

lt-branch-arrow_level_1_active         >>>>>>       当前被点击的菜单分支祖先一级分支图标的样式
lt-branch-arrow_level_2_active         >>>>>>       当前被点击的菜单分支祖先二级分支图标的样式
lt-branch-arrow_level_3_active         >>>>>>       当前被点击的菜单分支祖先三级分支图标的样式
……

注意：只有包含 parameter 的菜单分支被点击时才会增加 active 样式（还记得 listData 参数里的 parameter 属性吗）。

以上所有涉及到的样式都可以在引入插件的组件中定义，但有个前提，style 属性不能设置为 scoped