Migración a @waline/client V2

Cambios en la API

Hemos eliminado la exportación predeterminada de Waline y, en su lugar, ofrecemos las siguientes exportaciones:

• init: se comporta como el antiguo Waline
• version: número de versión
• commentCount: número de comentarios actualizados
• pageviewCount: actualiza el número de visitas
• RecentComments: comentarios recientes

Cambiamos la exportación predeterminada de Waline por la exportación con nombre init y, para que Waline sea compatible con SSR, V2 exporta el CSS por separado.

En la mayoría de los casos, esto solo implica los siguientes cambios:

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

Opciones añadidas

• La opción comment admite cadenas como selectores CSS.
• La opción pageview admite cadenas como selectores CSS.

Opciones renombradas

• uploadImage se renombra a imageUploader

• highlight se renombra a highlighter

• previewMath se renombra a texRenderer

• visitor se renombra a pageview

Opciones eliminadas

Las siguientes opciones llevaban mucho tiempo marcadas como APIs obsoletas en V1 y se han eliminado en V2.

• langMode: usa locale
• placeholder: usa locale.placeholder
• emojiCDN: usa emoji
• emojiMaps: usa emoji
• requiredFields: usa requiredMeta
• avatar: usa la variable del servidor AVATAR_PROXY
• avatarCDN: usa la variable del servidor AVATAR_PROXY
• avatarForce: se actualiza de forma predeterminada
• anonymous: usa login
• mathTagSupport: usa texRenderer
• copyRight: usa copyright

Otros cambios

Instancia

Waline.init ahora lanza un error cuando las dos propiedades obligatorias el y serverURL no son válidas, en lugar de devolver una instancia de error con un motivo.

Puedes usar bloques try { ... } catch (err) { ... } para capturar los errores y lograr una mejor compatibilidad en caso de que el usuario establezca opciones no válidas.

Cambios en el comportamiento de actualización

• Waline ahora admite actualizar todas las opciones excepto la opción el mediante Instance.update.
• El parámetro path se restablece en update(), lo que significa que, siempre que no pases la opción path durante update(), será window.location.pathname.

Cambios en los selectores de comentarios y visitas

Ya se ha eliminado la compatibilidad con los selectores de comentarios y visitas de Valine.

• El selector de comentarios es por defecto '.waline-comment-count'
• El selector de visitas es por defecto '.waline-pageview-count'

Si necesitas obtener para un selector un valor distinto al de la página actual, se recomienda encarecidamente usar el atributo data-path.

Por compatibilidad, seguimos manteniendo el soporte del atributo id anterior, pero esta compatibilidad se eliminará en V3.

Cambios en las clases CSS

Todas las clases CSS cambiaron de v a wl-.