Переход на @waline/client V2

Изменения API

Мы убрали экспорт Waline по умолчанию и вместо него предоставляем следующие экспорты:

• init: ведёт себя как прежний Waline
• version: номер версии
• commentCount: обновляет количество комментариев
• pageviewCount: обновляет количество просмотров
• RecentComments: последние комментарии

Экспорт Waline по умолчанию заменён на именованный экспорт init; кроме того, чтобы Waline лучше работал с SSR, в V2 CSS экспортируется отдельно.

В большинстве случаев это означает лишь следующие изменения:

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

Добавленные параметры

• Параметр comment поддерживает строки в качестве CSS-селекторов.
• Параметр pageview поддерживает строки в качестве CSS-селекторов.

Переименованные параметры

• uploadImage переименован в imageUploader

• highlight переименован в highlighter

• previewMath переименован в texRenderer

• visitor переименован в pageview

Удалённые параметры

Следующие параметры давно были помечены в V1 как устаревшие API, и в V2 они удалены.

• langMode: используйте locale
• placeholder: используйте locale.placeholder
• emojiCDN: используйте emoji
• emojiMaps: используйте emoji
• requiredFields: используйте requiredMeta
• avatar: используйте серверную переменную AVATAR_PROXY
• avatarCDN: используйте серверную переменную AVATAR_PROXY
• avatarForce: по умолчанию аватары обновляются
• anonymous: используйте login
• mathTagSupport: используйте texRenderer
• copyRight: используйте copyright

Прочие изменения

Экземпляр

Теперь Waline.init выбрасывает ошибку, если два обязательных свойства el и serverURL неверны, а не возвращает экземпляр с ошибкой и её причиной.

Можно использовать блоки try { ... } catch (err) { ... } для перехвата ошибок — так лучше совместимость на случай, если пользователь задал неверные параметры.

Изменения поведения при обновлении

• Теперь Waline поддерживает обновление всех параметров, кроме el, через Instance.update.
• Параметр path сбрасывается при update(): если не передать параметр path во время update(), он будет равен window.location.pathname.

Изменения селекторов комментариев и просмотров

Совместимость с селекторами Valine для комментариев и просмотров теперь удалена.

• Селектор комментариев по умолчанию — '.waline-comment-count'
• Селектор просмотров по умолчанию — '.waline-pageview-count'

Если для селектора нужно значение, отличное от текущей страницы, настоятельно рекомендуется использовать атрибут data-path.

Для совместимости мы по-прежнему поддерживаем прежний атрибут id, но эта совместимость будет удалена в V3.

Изменения CSS-классов

Все CSS-классы изменены с v на wl-.