[[351043]]

開(kāi)門(mén)見(jiàn)山

Demo 演示地址：http://www.longstudy.club/vue-okr-tree-doc/index.html

github 地址：https://github.com/qq449245884/vue-okr-tree

項(xiàng)目背景

因?yàn)樽罱拘枰鲆粋€(gè)OKR，OKR 里面有個(gè)對(duì)齊視圖，是一個(gè)數(shù)型結(jié)構(gòu)，如下圖所示：

就拿我 小智 來(lái)說(shuō)，如果有人對(duì)齊我的 KR 就放到我的右邊，如果是我對(duì)齊了誰(shuí)的 KR，就放到我的左邊，類似一個(gè)上下級(jí)的關(guān)系，所以這里我用兩棵樹(shù)來(lái)表示左邊與右邊的關(guān)系。

在GitHub上找了半天，這類組件不多，也沒(méi)有符合業(yè)務(wù)需求的組件，所以決定自己造輪子!

分析

• 既然是樹(shù)，那么每個(gè)節(jié)點(diǎn)都應(yīng)該是相同的組件
• 節(jié)點(diǎn)下面套節(jié)點(diǎn)，所以節(jié)點(diǎn)組件應(yīng)該是一個(gè)遞歸組件
• 整棵樹(shù)應(yīng)該有一個(gè)全局的狀態(tài)，用來(lái)管理從外部傳入的值以及向外部提供的屬性和方法。
• 每相樹(shù)節(jié)點(diǎn)應(yīng)該也要有一個(gè)對(duì)應(yīng)的節(jié)點(diǎn)狀態(tài)，來(lái)管理節(jié)點(diǎn)自身屬性和方法。

實(shí)現(xiàn)思路

遞歸組件

對(duì)于遞歸組件，Vue 官方文檔是這樣說(shuō)的：

組件在它的模板內(nèi)可以遞歸地調(diào)用自己。不過(guò)，只有當(dāng)它有 name 選項(xiàng)時(shí)才可以這么做。

這里我用 OkrTreeNode.vue 來(lái)表示樹(shù)的節(jié)點(diǎn)，里面是這樣用遞歸，下面是該組件簡(jiǎn)定：

<template> 
  <OkrTreeNode 
    v-for="child in leftChildNodes" 
    :node="child" 
  ></OkrTreeNode> 
</template> 
 
export default { 
  name: 'OkrTreeNode' 
} 

遞歸組件的使用需要注意的兩點(diǎn)是組件里面要有組件name 以及結(jié)束遞歸的條件。

樹(shù)的狀態(tài)

對(duì)于樹(shù)的狀態(tài)，我用一個(gè) TreeStore 類來(lái)表示，該實(shí)現(xiàn)方式主要是參考 ElementUI 中的 tree 組件。TreeStore 中的屬性就表示我外部傳入的 pros 或者 attr 或者 事件和方法，都在這個(gè)對(duì)象里面管理，具體的代碼可以看這里：

https://github.com/qq449245884/vue-okr-tree/blob/main/src/lib/vue-okr-tree/model/tree-store.js

節(jié)點(diǎn)的狀態(tài)

對(duì)于節(jié)點(diǎn)的狀態(tài)，我用一個(gè) Node 對(duì)象來(lái)表示，具體的代碼可以看下面這個(gè)地址，這里就不展開(kāi)說(shuō)了：

https://github.com/qq449245884/vue-okr-tree/blob/main/src/lib/vue-okr-tree/model/node.js

Demo 演示

基礎(chǔ)用法

基礎(chǔ)的樹(shù)形結(jié)構(gòu)展示，默認(rèn)方式垂直方向。

水平方向

將 direction 屬性設(shè)置為 horizontal 就可以展示水平方向。

節(jié)點(diǎn)是否可被展開(kāi)

節(jié)點(diǎn)可被展開(kāi),默認(rèn)是不展開(kāi)，通過(guò)show-collapsable設(shè)置節(jié)點(diǎn)可被展開(kāi)。

節(jié)點(diǎn)默認(rèn)全部展開(kāi)

通過(guò)設(shè)置 default-expand-all 默認(rèn)展開(kāi)所有節(jié)點(diǎn)，該參數(shù)只有在 show-collapsable為true 時(shí)有效

可將 Tree 的某些節(jié)點(diǎn)設(shè)置為默認(rèn)展開(kāi)

通過(guò) default-expanded-keys 設(shè)置默認(rèn)展開(kāi)的節(jié)點(diǎn)。需要注意的是，此時(shí)必須設(shè)置 node-key ，其值為節(jié)點(diǎn)數(shù)據(jù)中的一個(gè)字段名，該字段在整棵樹(shù)中是唯一的。

節(jié)點(diǎn)的樣式可自行設(shè)置節(jié)點(diǎn)的默認(rèn)樣式和選中的樣式。

通過(guò) label-class-name 設(shè)置節(jié)點(diǎn)的樣式，支持字符和函數(shù)方式。通過(guò) current-lable-class-name 設(shè)置當(dāng)前節(jié)點(diǎn)選中的樣式，支持字符和函數(shù)方式。

節(jié)點(diǎn)自定義內(nèi)容

可自行設(shè)置節(jié)點(diǎn)內(nèi)容。通過(guò) render-content 渲染節(jié)點(diǎn)內(nèi)容。

OKR 展示模式

該模式的出現(xiàn)，是為了實(shí)現(xiàn)跟飛書(shū)OKR 展示的視圖一樣效果，所以在 Tree 的模式下，擴(kuò)展成左右兩棵子樹(shù)。該模式必須設(shè)置 onlyBothTree ，以及通過(guò) leftData表示左子數(shù)的結(jié)構(gòu)。

OKR 展示模式之自定義節(jié)點(diǎn)內(nèi)容

與上常規(guī) Tree 一樣，我們也可以通過(guò)自定義渲染函數(shù)來(lái)制定節(jié)點(diǎn)的內(nèi)容。

通過(guò) render-content 渲染節(jié)點(diǎn)內(nèi)容，通過(guò)返回 node 中的 isLeftChild 判斷是否是左邊的樹(shù)。

節(jié)點(diǎn)過(guò)濾(不可展開(kāi))及支持的方法

通過(guò)關(guān)鍵字過(guò)濾樹(shù)節(jié)點(diǎn)，在需要對(duì)節(jié)點(diǎn)進(jìn)行過(guò)濾時(shí)，調(diào)用 Tree 實(shí)例的 filter 方法，參數(shù)為關(guān)鍵字。需要注意的是，此時(shí)需要設(shè)置 filter-node-method ，值為過(guò)濾函數(shù)。

節(jié)點(diǎn)過(guò)濾(可被展開(kāi))

通過(guò)關(guān)鍵字過(guò)濾樹(shù)節(jié)點(diǎn)，在需要對(duì)節(jié)點(diǎn)進(jìn)行過(guò)濾時(shí)，調(diào)用 Tree 實(shí)例的 filter 方法，參數(shù)為關(guān)鍵字。需要注意的是，此時(shí)需要設(shè)置 filter-node-method ，值為過(guò)濾函數(shù)。

支持的事件(不可展開(kāi))

不可展開(kāi)時(shí)支持的事件有 節(jié)點(diǎn)點(diǎn)擊 和 鼠標(biāo)右鍵點(diǎn)擊。

支持的事件(可被展開(kāi))

可展開(kāi)時(shí)支持的事件有 節(jié)點(diǎn)點(diǎn)擊、鼠標(biāo)右鍵點(diǎn)擊，節(jié)點(diǎn)的展開(kāi)以及節(jié)點(diǎn)的關(guān)閉。

Attributes

props

## Events

方法

瀏覽器支持情況

Modern browsers and Internet Explorer 10+.

如果你覺(jué)得還不錯(cuò)的話，還請(qǐng)幫忙在 github 上給個(gè) star，如果你覺(jué)得哪些需要優(yōu)化的可以到 github 上提個(gè) PR。

本文轉(zhuǎn)載自微信公眾號(hào)「大遷世界」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系大遷世界公眾號(hào)。