Migration zu @waline/client V2

API-Änderungen

Wir haben den Standard-Export von Waline entfernt und stattdessen die folgenden Exporte bereitgestellt:

• init: verhält sich wie das alte Waline
• version: version number
• commentCount: Anzahl der aktualisierten Kommentare
• pageviewCount: Anzahl der Besuche aktualisieren
• RecentComments: neueste Kommentare

Wir haben den Standard-Export von Waline in den benannten Export init geändert, und um Waline SSR-freundlich zu machen, exportiert V2 CSS separat.

In den meisten Fällen bedeutet dies nur die folgenden Änderungen:

- <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>

Hinzugefügte Optionen

• Die Option comment unterstützt das Festlegen von Strings als CSS-Selektoren.
• Die Option pageview unterstützt das Festlegen von Strings als CSS-Selektoren.

Umbenannte Optionen

• uploadImage umbenannt in imageUploader

• highlight umbenannt in highlighter

• previewMath umbenannt in texRenderer

• visitor umbenannt in pageview

Entfernte Optionen

Die folgenden Optionen wurden in V1 lange als veraltete APIs gekennzeichnet, sie wurden in V2 entfernt.

• langMode: verwenden Sie locale
• placeholder: verwenden Sie locale.placeholder
• emojiCDN: verwenden Sie emoji
• emojiMaps: verwenden Sie emoji
• requiredFields: verwenden Sie requiredMeta
• avatar: verwenden Sie die Servervariable AVATAR_PROXY
• avatarCDN: verwenden Sie die Servervariable AVATAR_PROXY
• avatarForce: standardmäßig aktualisieren
• anonymous: verwenden Sie login
• mathTagSupport: verwenden Sie texRenderer
• copyRight: verwenden Sie copyright

Weitere Änderungen

Instanz

Waline.init löst jetzt einen Fehler aus, wenn die beiden erforderlichen Eigenschaften el, serverURL ungültig sind, anstatt eine Fehlerinstanz mit Grund zurückzugeben.

Sie können try { ... } catch (err) { ... } Blöcke verwenden, um Fehler für eine bessere Kompatibilität abzufangen, falls der Benutzer ungültige Optionen festlegt.

Änderungen am Update-Verhalten

• Waline unterstützt jetzt das Aktualisieren aller Optionen außer der Option el über Instance.update.
• Der Parameter path wird bei update() zurückgesetzt, was bedeutet, dass es window.location.pathname ist, solange Sie während update() keine path-Optionen übergeben.

Änderungen an Kommentar- und Seitenaufrufe-Selektoren

Kommentare und Ansichten zur Selektorkompatibilität von Valine wurden jetzt entfernt.

• Der Kommentarselektor ist standardmäßig '.waline-comment-count'
• Der Seitenaufruf-Selektor ist standardmäßig '.waline-pageview-count'

Wenn Sie einen anderen Wert für einen Selektor als die aktuelle Seite benötigen, wird dringend empfohlen, das Attribut data-path zu verwenden.

Aus Kompatibilitätsgründen behalten wir weiterhin die vorherige Unterstützung des id-Attributs bei, aber diese Kompatibilität wird in V3 entfernt.

Änderungen an CSS-Klassen

Alle CSS-Klassen wurden von v zu wl- geändert.