溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

基于Vue的側(cè)邊目錄組件的實現(xiàn)

發(fā)布時間:2020-08-27 13:25:03 來源:腳本之家 閱讀:313 作者:啊姚 欄目:web開發(fā)

最近要做一個側(cè)邊目錄的功能,沒有找到類似的組件,索性自己寫了一個供大家參考

vue-side-catalog

一個基于vue的側(cè)邊目錄組件。

基于Vue的側(cè)邊目錄組件的實現(xiàn)

源碼地址:https://github.com/yaowei9363/vue-side-catalog

安裝

npm install vue-side-catalog -S

開始

<template>
 <div id="app">
  <div class="demo">
   <h2>JavaScript</h2>
   <h3>歷史</h3>
   <h4>肇始于網(wǎng)景</h4>
   <h4>微軟采納</h4>
   <h4>標準化</h4>
   <h3>概論</h3>
   <h3>特性</h3>
  </div>
 <side-catalog 
  v-bind="catalogProps"
 ></side-catalog>
 </div>
</template>
import SideCatalog from 'vue-side-catalog'
import 'vue-side-catalog/lib/vue-side-catalog.css'
export default {
 components: {
  SideCatalog,
 },
 data() {
  return {
   catalogProps:{
     containerElementSelector: '.demo',
   },
  };
 },
}
注意: containerElementSelector 屬性是必需的,指定文章的容器。

效果如下圖:

基于Vue的側(cè)邊目錄組件的實現(xiàn)

示例

自定義目錄標簽

組件默認會把containerElementSelector元素的直接子集的header標簽作為目錄內(nèi)容,
對應(yīng)規(guī)則為:
h3 => 一級目錄
h4 => 二級目錄
h5 => 三級目錄
h6 => 四級目錄
要修改這一規(guī)則可以使用 headList 屬性,這個屬性的默認值為["h3", "h4", "h5", "h6"]對應(yīng)上述規(guī)則

注意:自定義題目標簽?zāi)壳爸恢С?code>containerElementSelector元素的直接子集的html標簽
 data(){
  return {
   catalogProps:{
    headList: ["h2", "h3", "h4", "h5", "h6"], // 使h2作為一級目錄
    // headList: ["h4", "h2", "p", "span"], // 指定不同的標簽為目錄
   },
  };
 },

基于Vue的側(cè)邊目錄組件的實現(xiàn)

自定義目錄元素

跟上面的自定義目錄標簽不同,自定義目錄元素可以支持任意層級含有ref屬性的元素,也可以支持組件
需要用到 refList 屬性

<template>
  <h2>JavaScript</h2>
  <h3 ref="t1">歷史</h3>
  <h4 ref="t1-1">肇始于網(wǎng)景</h4>
  <h4 ref="t1-2">微軟采納</h4>
  <h4 ref="t1-3">標準化</h4>
  <h3 ref="t2">概論</h3>
  <h3 ref="t3">特性</h3>
  <version ref="t4"/>
  <!-- ... -->
</template>
//...
import Version from './components/Version';
export default {
 components: {
  // ...
  Version,
 },
 data() {
  return {
   catalogProps:{
     containerElementSelector: '.demo',
     refList:[
     {
      ref: 't1'
     },
     {
      ref: 't1-1',
      level: 2 // 指定為二級目錄
     },
     {
      ref: 't1-2',
      level: 2
     },
     {
      ref: 't1-3',
      level: 2
     },
     {
      ref: 't2'
     },
     {
      ref: 't3'
     },
     {
      ref: 't4',
      title: '版本' // 組件需要單獨設(shè)置title(默認取innerText)
     },
    ]
   },
  };
 },
}

效果如下圖:

基于Vue的側(cè)邊目錄組件的實現(xiàn)

注意:headListrefList 同時設(shè)置的話,會忽視headList

指定元素滾動

也可以使用 scrollElementSelector 對固定元素的內(nèi)容生成目錄,如果不指定該屬性則默認監(jiān)聽Window的scroll事件

 data(){
  return {
   catalogProps:{
    scrollElementSelector: '.demo',
   },
  };
 },
.demo {
 height: 400px;
 overflow: auto;
}

效果如下圖:

基于Vue的側(cè)邊目錄組件的實現(xiàn)

在線示例

點擊這里

Props

Name Type Default Description
headList Array ["h3", "h4", "h5", "h6"] 為每級目錄指定標簽
refList Array - 為每級目錄指定ref元素,數(shù)組每項為對象,包含兩個屬性<ul><li>ref(必需)該行目錄對象的refName</li><li>title該行目錄的名稱(默認取innerText)</li><li>level(默認為1)該行目錄級別</li></ul>
containerElementSelector String - (必需)指定文章的容器
scrollElementSelector String Window 需要添加scroll事件的css選擇器,默認監(jiān)聽window的scroll事件
openDomWatch Boolean false 是否開啟dom監(jiān)聽,如果containerElementSelector中有dom變化會重新計算每級目錄的offsetTop

Methods

Name Parameters Description
initActive - 使目錄第一行處于active狀態(tài)
setRefList - 計算每級目錄的offsetTop

Slot

Name Description
- 目錄的題目

以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持億速云。

向AI問一下細節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI