Markodwn 標題對齊的同步滾動

初之發表於2019-04-28
Markodwn

前言

需要給正在寫的Markodwn編輯器加上同步滾動的功能，百度了一通，沒找到比較好的思路。就自己寫了一個。

Github上是寫好的庫，和更直觀的Demo。 Github

這篇文章主要講的是實現的思路。

介紹

同步滾動的實現方式有很多種。簡單粗暴的就直接讓HTMLElement.scrollTop相等，還有就是讓滾動條等比例滾動，還有標題對齊的滾動（這個是我在stackedit上看到的）。

這篇文章主要的內容是標題對齊同步滾動的實現方式。

個人來講比較喜歡標題對齊，因為這種方式相對於另外兩個對使用者更友好。

從原理上來講標題對齊實際上是等比例滾動的改良版。因為他們的核心都是通過計算編輯區和預覽區的高度比值決定滾動的距離。

DEMO

下面是DEMO的GIF圖

Markodwn 標題對齊的同步滾動
注意左邊的# 同步滾動 同步滾動。

可以看到隨著滾動條的移動，左右兩邊滾動的距離是不同的。

這個看起來有點像等比例滾動，但是他們是不一樣的，區別在等比例滾動根據兩邊的全文高度決定滾動距離，標題對齊方式根據標題下內容高度決定滾動距離。

思路

Markodwn 標題對齊的同步滾動
上圖是一張示意圖：

# heading表示標題，content表示標題下面的內容。我把標題+內容稱為片段（fragment）。

等比例滾動我想應該比較好理解，就是通過計算編輯區和預覽區的高度比值，然後根據比值再計算滾動距離。

而標題對齊要更加精確一些，它把編輯區和預覽區的高度換成了標題高度+標題下內容的高度即片段的高度，然後根據當前的片段對應的高度計算滾動距離。

Markodwn 標題對齊的同步滾動

上面的示意圖中的md height和html height就是我們需要的片段的高度。 很明顯只要我們根據這兩個高度的比值就可以計算出相對應滾動的距離。

具體過程

  1. 首先需要編輯區和預覽區的標題資訊，資料結構如下。這裡用editFragmentsInfo和preFragmentsInfo代替
FragmentInfo: {
    pairId,         // 於編輯區/預覽區相對應的標題匹配用的id
    offsetTop,      // 距離頂部偏移的距離
    height          // 標題加上內容的高度
}
複製程式碼
  1. 然後需要能夠獲取當前頁面頂部的標題塊的方法，這裡用getCurrentFragment()代替
  2. 接下來要在 編輯區（editArea）/預覽區（previewArea） 的滾動事件中向 預覽區（previewArea）/編輯區（editArea） 傳送訊息通知它要開始滾動了。
  3. 在另一區域接收到之後，進行以下操作。（假設主動滾動的是編輯區，被動滾動的是預覽區即另一區域）
    1. 先要拿到當前在頂部的標題，用上面提到的getCurrentHeading()獲取。
    2. 然後要在預覽區中匹配到對應的標題。
    3. 根據兩邊headingInfo.height的比值計算出的數值再加上headingInfo.offsetTop的值就是預覽區的scrollTop。
  4. 到此為止，一次同步就結束了。這一過程是繫結在元素的滾動事件上的，每次滾動都會觸發一次這樣的過程。
同步問題

因為一個元素的滾動會導致另一個元素滾動，這必定會形成死迴圈。所以在滾動事件中一定要進行判斷，避免死迴圈。

這是簡單的互斥方法，支援兩個以上物件的互斥 互斥鎖

相關文章