Migração para @waline/client V2

Mudanças na API

Removemos a exportação padrão do Waline e, em vez disso, fornecemos as seguintes exportações:

• init: comporta-se como o antigo Waline
• version: número da versão
• commentCount: número de comentários atualizados
• pageviewCount: atualiza o número de visitas
• RecentComments: comentários recentes

Alteramos a exportação padrão do Waline para a exportação nomeada init e, para tornar o Waline compatível com SSR, a V2 exporta o CSS separadamente.

Na maioria dos casos, isso significa apenas as seguintes mudanças:

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

Opções adicionadas

• A opção comment agora aceita strings como seletores CSS.
• A opção pageview agora aceita strings como seletores CSS.

Opções renomeadas

• uploadImage renomeado para imageUploader

• highlight renomeado para highlighter

• previewMath renomeado para texRenderer

• visitor renomeado para pageview

Opções removidas

As opções a seguir já estavam marcadas há muito tempo como APIs obsoletas na V1 e foram removidas na V2.

• langMode: use locale
• placeholder: use locale.placeholder
• emojiCDN: use emoji
• emojiMaps: use emoji
• requiredFields: use requiredMeta
• avatar: use a variável de servidor AVATAR_PROXY
• avatarCDN: use a variável de servidor AVATAR_PROXY
• avatarForce: a atualização é o padrão
• anonymous: use login
• mathTagSupport: use texRenderer
• copyRight: use copyright

Outras mudanças

Instância

Agora Waline.init lança um erro quando as duas propriedades obrigatórias el e serverURL são inválidas, em vez de retornar uma instância de erro com o motivo.

Você pode usar blocos try { ... } catch (err) { ... } para capturar erros e obter melhor compatibilidade caso o usuário defina opções inválidas.

Mudanças no comportamento de atualização

• Agora o Waline permite atualizar todas as opções, exceto a opção el, via Instance.update.
• O parâmetro path é redefinido em update(), o que significa que, se você não passar a opção path durante update(), ele será window.location.pathname.

Mudanças nos seletores de comentários e visualizações

A compatibilidade com os seletores de comentários e de visualizações do Valine foi removida.

• O seletor de comentários usa '.waline-comment-count' por padrão
• O seletor de visualizações usa '.waline-pageview-count' por padrão

Se você precisar que um seletor obtenha um valor diferente do da página atual, é altamente recomendável usar o atributo data-path.

Por compatibilidade, ainda mantemos o suporte ao antigo atributo id, mas essa compatibilidade será removida na V3.

Mudanças nas classes CSS

Todas as classes CSS mudaram de v para wl-.