Waline 客戶端 V2 遷移指南

API 變更

我們取消了 Waline 的預設匯出，進而提供下列匯出:

• init: 行為模式同舊版的 Waline
• version: 版本號
• commentCount: 更新留言數
• pageviewCount: 更新造訪數
• RecentComments: 最近留言

我們將 Waline 的預設匯出改為 init 具名匯出，同時為了使 Waline 對 SSR 友善，V2 將 CSS 單獨輸出。

在多數情況下，這只意味著下列變更:

- <script src='//cdn.jsdelivr.net/npm/@waline/client'></script>
+ <script src='//unpkg.com/@waline/client@v2/dist/waline.js'></script>
+ <link href='//unpkg.com/@waline/client@v2/dist/waline.css' rel='stylesheet' />

  <script>
-  Waline({
+  Waline.init({
    el: '#waline',
    serverURL: 'YOUR SERVER URL'
  });
  </script>

新增選項

• comment 選項支援設定字串作為 CSS 選擇器。
• pageview 選項支援設定字串作為 CSS 選擇器。

選項重新命名

• uploadImage 更名為 imageUploader

• highlight 更名為 highlighter

• previewMath 更名為 texRenderer

• visitor 更名為 pageview

選項移除

以下選項已在 V1 中長時間標記為棄用的 API，它們已在 V2 中移除。

• langMode: 使用 locale
• placeholder: 使用 locale.placeholder
• emojiCDN: 使用 emoji
• emojiMaps: 使用 emoji
• requiredFields: 使用 requiredMeta
• avatar: 使用伺服器變數 AVATAR_PROXY
• avatarCDN: 使用伺服器變數 AVATAR_PROXY
• avatarForce: 預設重新整理
• anonymous: 使用 login
• mathTagSupport: 不再需要
• copyRight: 使用 copyright

其他變更

實例變更

現在 Waline.init 會在 el, serverURL 兩個必填屬性無效時直接拋出錯誤，而不是回傳一個錯誤實例說明原因。

你可以使用 try { ... } catch (err) { ... } 區塊來捕捉錯誤，以更好地相容使用者設定錯誤的情況。

更新行為變更

• Waline 現在支援透過 Instance.update 更新 el 選項之外的所有選項。
• path 參數在 update() 時會被重設，這意味著只要你不傳入 path，它就會被重設為 window.location.pathname。

留言與瀏覽量選擇器變更

現在，留言與瀏覽量關於 Valine 的選擇器相容已被移除。

• 留言選擇器預設為 '.waline-comment-count'
• 瀏覽量選擇器預設為 '.waline-pageview-count'

如果你需要為某個選擇器取得不同於目前頁面的對應值時，強烈建議使用 data-path 屬性。

為了相容性，我們仍然保留先前的 id 屬性支援，但此相容會在 V3 移除。

CSS 類別變更

所有 CSS 類別從 v 開頭改為 wl- 開頭。