Migrasi ke @waline/client V2

Perubahan API

Kami menghapus ekspor default Waline dan sebagai gantinya menyediakan ekspor berikut:

• init: berperilaku seperti Waline lama
• version: nomor versi
• commentCount: jumlah komentar yang diperbarui
• pageviewCount: perbarui jumlah kunjungan
• RecentComments: komentar terbaru

Kami mengubah ekspor default Waline menjadi ekspor bernama init, dan untuk membuat Waline ramah SSR, V2 mengekspor CSS secara terpisah.

Dalam kebanyakan kasus, ini hanya berarti perubahan berikut:

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

Opsi yang Ditambahkan

• Opsi comment mendukung pengaturan string sebagai selektor CSS.
• Opsi pageview mendukung pengaturan string sebagai selektor CSS.

Opsi yang Diganti Namanya

• uploadImage diganti namanya menjadi imageUploader

• highlight diganti namanya menjadi highlighter

• previewMath diganti namanya menjadi texRenderer

• visitor diganti namanya menjadi pageview

Opsi yang Dihapus

Opsi-opsi berikut telah lama ditandai sebagai API yang sudah usang di V1, mereka telah dihapus di V2.

• langMode: gunakan locale
• placeholder: gunakan locale.placeholder
• emojiCDN: gunakan emoji
• emojiMaps: gunakan emoji
• requiredFields: gunakan requiredMeta
• avatar: gunakan variabel server AVATAR_PROXY
• avatarCDN: gunakan variabel server AVATAR_PROXY
• avatarForce: refresh secara default
• anonymous: gunakan login
• mathTagSupport: gunakan texRenderer
• copyRight: gunakan copyright

Perubahan Lainnya

Instans

Waline.init sekarang melempar error ketika dua properti wajib el, serverURL tidak valid, bukan mengembalikan instance error dengan alasan.

Anda dapat menggunakan blok try { ... } catch (err) { ... } untuk menangkap error demi kompatibilitas yang lebih baik jika pengguna menetapkan opsi yang tidak valid.

Perubahan perilaku pembaruan

• Waline sekarang mendukung pembaruan semua opsi kecuali opsi el melalui Instance.update.
• Parameter path akan direset pada update(), yang berarti selama Anda tidak meneruskan opsi path selama update(), nilainya akan menjadi window.location.pathname.

Perubahan Selektor Komentar dan Tampilan Halaman

Kompatibilitas selektor komentar dan tampilan halaman dengan Valine kini telah dihapus.

• Selektor komentar defaultnya adalah '.waline-comment-count'
• Selektor tampilan halaman defaultnya adalah '.waline-pageview-count'

Jika Anda perlu mendapatkan nilai yang berbeda untuk selektor selain halaman saat ini, sangat disarankan untuk menggunakan atribut data-path.

Untuk kompatibilitas, kami masih mempertahankan dukungan atribut id sebelumnya, tetapi kompatibilitas ini akan dihapus di V3.

Perubahan kelas CSS

Semua kelas CSS berubah dari v menjadi wl-.