@waline/client 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: texRendererを使用してください
• copyRight: copyrightを使用してください

その他の変更

インスタンス

Waline.initは、必須プロパティであるelとserverURLが無効な場合に、理由付きのエラーインスタンスを返すのではなく、エラーをスローするようになりました。

ユーザーが無効なオプションを設定した場合の互換性を高めるため、try { ... } catch (err) { ... }ブロックでエラーをキャッチできます。

更新動作の変更

• Walineはelオプションを除くすべてのオプションを、Instance.updateで更新できるようになりました。
• pathパラメータはupdate()でリセットされます。つまり、update()時にpathオプションを渡さない限り、window.location.pathnameになります。

コメントとページビューのセレクターの変更

Valineのセレクターとの互換性は現在削除されています。

• コメントのセレクターはデフォルトで'.waline-comment-count'です
• ページビューのセレクターはデフォルトで'.waline-pageview-count'です

セレクターで現在のページとは異なる値を取得する必要がある場合は、data-path属性の使用を強くお勧めします。

互換性のため、以前のid属性のサポートは残していますが、この互換性はV3で削除されます。

CSSクラスの変更

すべてのCSSクラスがvからwl-に変更されました。