Migrazione a @waline/client V2

Modifiche alle API

Abbiamo rimosso l'export predefinito di Waline e forniamo invece i seguenti export:

• init: si comporta come il vecchio Waline
• version: numero di versione
• commentCount: aggiorna il numero di commenti
• pageviewCount: aggiorna il numero di visualizzazioni
• RecentComments: commenti recenti

Abbiamo trasformato l'export predefinito di Waline nell'export con nome init e, per rendere Waline compatibile con SSR, V2 esporta il CSS separatamente.

Nella maggior parte dei casi questo comporta solo le seguenti modifiche:

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

Opzioni aggiunte

• L'opzione comment supporta stringhe impostate come selettori CSS.
• L'opzione pageview supporta stringhe impostate come selettori CSS.

Opzioni rinominate

• uploadImage è stata rinominata in imageUploader

• highlight è stata rinominata in highlighter

• previewMath è stata rinominata in texRenderer

• visitor è stata rinominata in pageview

Opzioni rimosse

Le seguenti opzioni erano già contrassegnate da tempo come API deprecate in V1 e sono state rimosse in V2.

• langMode: usa locale
• placeholder: usa locale.placeholder
• emojiCDN: usa emoji
• emojiMaps: usa emoji
• requiredFields: usa requiredMeta
• avatar: usa la variabile del server AVATAR_PROXY
• avatarCDN: usa la variabile del server AVATAR_PROXY
• avatarForce: l'aggiornamento ora è predefinito
• anonymous: usa login
• mathTagSupport: usa texRenderer
• copyRight: usa copyright

Altre modifiche

Istanza

Ora Waline.init genera un errore quando le due proprietà obbligatorie el e serverURL non sono valide, invece di restituire un'istanza di errore con il motivo.

Puoi usare blocchi try { ... } catch (err) { ... } per intercettare gli errori e ottenere una migliore compatibilità nel caso in cui l'utente imposti opzioni non valide.

Modifiche al comportamento di aggiornamento

• Ora Waline consente di aggiornare tutte le opzioni tranne el tramite Instance.update.
• Il parametro path viene reimpostato con update(): se non passi l'opzione path durante update(), il suo valore sarà window.location.pathname.

Modifiche ai selettori di commenti e visualizzazioni

La compatibilità con i selettori di Valine per commenti e visualizzazioni è stata ora rimossa.

• Il selettore dei commenti usa per impostazione predefinita '.waline-comment-count'
• Il selettore delle visualizzazioni usa per impostazione predefinita '.waline-pageview-count'

Se hai bisogno di ottenere per un selettore un valore diverso da quello della pagina corrente, ti consigliamo vivamente di usare l'attributo data-path.

Per compatibilità manteniamo ancora il supporto al precedente attributo id, ma questa compatibilità verrà rimossa in V3.

Modifiche alle classi CSS

Tutte le classi CSS sono passate da v a wl-.