Migration vers @waline/client V2

Changements d'API

Nous avons supprimé l'export par défaut de Waline et fournissons désormais les exports suivants :

• init : se comporte comme l'ancien Waline
• version : numéro de version
• commentCount : nombre de commentaires mis à jour
• pageviewCount : mise à jour du nombre de visites
• RecentComments : commentaires récents

Nous avons remplacé l'export par défaut de Waline par l'export nommé init et, pour rendre Waline compatible avec le SSR, la V2 exporte le CSS séparément.

Dans la plupart des cas, cela se traduit simplement par les changements suivants :

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

Options ajoutées

• L'option comment accepte une chaîne de caractères comme sélecteur CSS.
• L'option pageview accepte une chaîne de caractères comme sélecteur CSS.

Options renommées

• uploadImage renommée en imageUploader

• highlight renommée en highlighter

• previewMath renommée en texRenderer

• visitor renommée en pageview

Options supprimées

Les options suivantes étaient depuis longtemps marquées comme obsolètes en V1 ; elles ont été supprimées en V2.

• langMode : utilisez locale
• placeholder : utilisez locale.placeholder
• emojiCDN : utilisez emoji
• emojiMaps : utilisez emoji
• requiredFields : utilisez requiredMeta
• avatar : utilisez la variable serveur AVATAR_PROXY
• avatarCDN : utilisez la variable serveur AVATAR_PROXY
• avatarForce : actualisé par défaut
• anonymous : utilisez login
• mathTagSupport : utilisez texRenderer
• copyRight : utilisez copyright

Autres changements

Instance

Waline.init lève désormais une erreur lorsque les deux propriétés obligatoires el et serverURL sont invalides, au lieu de renvoyer une instance d'erreur avec une raison.

Vous pouvez utiliser des blocs try { ... } catch (err) { ... } pour intercepter les erreurs et améliorer la compatibilité dans le cas où l'utilisateur définit des options invalides.

Changements de comportement de mise à jour

• Waline prend désormais en charge la mise à jour de toutes les options sauf el via Instance.update.
• Le paramètre path est réinitialisé lors de l'appel à update(), ce qui signifie que si vous ne passez pas d'option path pendant update(), sa valeur sera window.location.pathname.

Changements des sélecteurs de commentaires et de pages vues

La compatibilité avec les sélecteurs de Valine pour les commentaires et les vues a été supprimée.

• Le sélecteur de commentaires vaut par défaut '.waline-comment-count'
• Le sélecteur de pages vues vaut par défaut '.waline-pageview-count'

Si vous devez obtenir pour un sélecteur une valeur différente de celle de la page courante, il est fortement recommandé d'utiliser l'attribut data-path.

Pour des raisons de compatibilité, nous conservons la prise en charge de l'ancien attribut id, mais cette compatibilité sera supprimée en V3.

Changements des classes CSS

Toutes les classes CSS sont passées de v à wl-.