EN

Pustaka & lisensi

Pustaka sumber terbuka yang dipakai Selaras, letak berkasnya, dan cara memperbarui atau membuangnya.

Pustaka pihak ketiga

Semuanya boleh disertakan dalam produk komersial sesuai lisensinya masing-masing.

PustakaVersiLisensiDipakai di
Bootstrap5.3.3MITSemua halaman
Tabler Icons3.19.0MITSemua halaman
Plus Jakarta SansFontSIL OFL 1.1Semua halaman
ApexCharts3.54.1MITSemua halaman ber-sidebar; grafik di empat dasbor dan Grafik
FullCalendar6.1.21MITKalender
SortableJS1.15.7MITKanban, Seret & lepas
DataTables2.3.8MITTabel data
jQuery3.7.1MITTabel data saja, untuk DataTables
Flatpickr4.6.13MITPemilih tanggal & warna
Tom Select2.6.2Apache-2.0Pemilih tanggal & warna
FilePond4.32.12MITUnggah berkas
Plugin FilePond4.6.12 · 1.2.9 · 2.2.8MITPratinjau gambar, pemeriksaan jenis dan ukuran berkas di Unggah berkas
SweetAlert211.26.25MITSweetAlert
Quill2.0.3BSD-3-ClauseEditor teks
marked12.0.2MITEditor teks (pratinjau Markdown)
DOMPurify3.1.6MPL-2.0 atau Apache-2.0Editor teks (membersihkan HTML pratinjau)
jsvectormap1.6.0MITPeta
Font Awesome Free7.3.1Ikon CC BY 4.0, font SIL OFL 1.1, kode MITIkon
Bootstrap Icons1.13.1MITIkon
Phosphor Icons2.1.2MITIkon

Plugin FilePond terdiri atas pratinjau gambar (4.6.12), validasi jenis berkas (1.2.9), dan validasi ukuran berkas (2.2.8). DataTables dimuat bersama paket gaya Bootstrap 5-nya, datatables.net-bs5, dengan versi yang sama.

Pemilih tanggal (sl-datepicker.js) dan pengunggah berkas (sl-upload.js) adalah bagian dari Selaras sendiri, bukan pustaka pihak ketiga.

Font Awesome wajib diberi kredit

Atribusi wajib

Ikon Font Awesome Free berlisensi CC BY 4.0, yang mewajibkan kredit. Bila produk Anda menyertakan ikon Font Awesome, sebutkan di halaman kredit, halaman tentang, atau dokumentasi Anda, dan pertahankan komentar lisensi di bagian atas berkas CSS-nya.

Kalimat kredit yang bisa Anda pakai:

Teks
Icons by Font Awesome Free (fontawesome.com), licensed under CC BY 4.0.

Di Selaras, Font Awesome hanya dimuat di UI Kit › Ikon, sebagai salah satu dari tiga set ikon opsional. Ikon bawaan di tempat lain adalah Tabler Icons, berlisensi MIT.

Letak berkas

Semua pustaka sudah termasuk dalam unduhan, di assets/vendor/ — satu folder per pustaka, dengan berkas lisensinya di sampingnya. Font-nya juga ada di sana, di assets/vendor/plus-jakarta-sans/. Tidak ada yang dimuat dari CDN, jadi halaman tetap berfungsi tanpa internet dan di intranet.

Halaman menautkan berkas-berkas itu di tiga tempat:

  • src/partials/head.html — font, CSS Bootstrap, dan Tabler Icons, untuk setiap halaman.
  • src/layout.html, src/layout-auth.html, src/layout-error.html dan src/layout-store.html — JavaScript Bootstrap; src/layout.html juga memuat ApexCharts.
  • Daftar "styles" dan "scripts" di baris meta setiap halaman di src/pages/ — semua pustaka lainnya, hanya di halaman itu.

Memperbarui pustaka

Versinya tercatat di vendor.json. Skrip tools/vendor.mjs menyalinnya ke assets/vendor/: berkas yang terdaftar, font dan gambar yang dirujuk stylesheet-nya, serta lisensinya.

  1. Baca dulu catatan rilis versi barunya (lihat Sebelum menaikkan versi pustaka), lalu ubah versinya di vendor.json.
  2. Jalankan skripnya. Skrip ini butuh Node.js 18 atau lebih baru dan koneksi internet — hanya untuk langkah ini.
    Terminal
    node tools/vendor.mjs
  3. Rakit ulang dengan node build.mjs. Tautan pustaka juga mendapat cap versi, jadi browser memuat berkas baru, bukan salinan lama dari cache.
  4. Periksa halaman yang memakai pustaka itu — daftarnya ada di tabel di atas — dalam mode terang dan gelap.

Skrip ini mengganti seluruh folder assets/vendor/, jadi simpan berkas Anda sendiri di tempat lain, misalnya di assets/js/. Path yang diawali assets/ disesuaikan otomatis untuk halaman Indonesia di id/.

Lebih suka CDN? Ganti path lokal dengan alamat CDN versi yang sama, misalnya https://cdn.jsdelivr.net/npm/apexcharts@3.54.1/dist/apexcharts.min.js, lalu rakit ulang.

Membuang pustaka yang tidak dipakai

Sebagian besar pustaka hanya dimuat di halaman yang memakainya, lewat meta "styles" dan "scripts" halaman itu. Menghapus satu pustaka tidak pernah memengaruhi halaman lain. Untuk membuang satu halaman UI Kit beserta pustakanya:

  1. Hapus sumber halamannya, misalnya src/pages/ui-pickers.html, beserta skripnya assets/js/ui-pickers.js.
  2. Hapus entrinya dari daftar NAV di build.mjs. Pencarian di halaman 404 dibuat dari daftar yang sama, jadi ikut diperbarui.
  3. Rakit ulang dengan node build.mjs, lalu hapus berkas hasil rakitan yang lama (ui-pickers.html dan id/ui-pickers.html) — perakit tidak menghapus halaman yang tidak lagi dibuatnya.
  4. Opsional: hapus kulit pustaka itu dari assets/css/selaras.css. Setiap kulit berada di bawah komentar judulnya sendiri, seperti Flatpickr 4.6 atau Tom Select 2.6.

Untuk mempertahankan halaman tetapi membuang salah satu pustakanya, hapus URL-nya dari meta halaman dan kode yang memanggil pustaka itu di skrip halaman.

Pustaka bersama

  • Bootstrap dan Tabler Icons dipakai di setiap halaman — dropdown, modal, tooltip, grid, dan semua ikon bergantung padanya. Jangan dihapus.
  • ApexCharts dimuat di setiap halaman yang punya sidebar. Kalau Anda tidak butuh grafik, hapus barisnya dari src/layout.html; halaman tetap berjalan, hanya grafiknya yang tidak digambar. Hapus juga kartu grafik di dasbor.
  • jQuery hanya dibutuhkan DataTables. SortableJS dipakai Kanban dan Seret & lepas, dan FullCalendar dipakai aplikasi Kalender.

Sebelum menaikkan versi pustaka

Selaras dibangun dan diuji dengan versi di atas. Sebelum pindah ke versi yang lebih baru, baca changelog dan lisensinya — ketentuannya bisa berubah antarversi.

  • ApexCharts — versi 3.54.1 berlisensi MIT. Periksa lisensi versi yang lebih baru sebelum menaikkan versi, karena bisa saja berbeda.
  • FullCalendar — Selaras memakai paket standar yang berlisensi MIT. FullCalendar juga menjual plugin premium (seperti tampilan timeline dan resource) dengan lisensi komersial. Plugin itu tidak disertakan; tambahkan hanya bila Anda membeli lisensinya.
  • SweetAlert2 — versi yang disertakan sudah diperiksa. Baca catatan rilis versi yang lebih baru sebelum menaikkan versi.
Menaikkan versi Bootstrap atau ApexCharts

Selaras menata ulang tampilan pustaka-pustaka ini secara mendalam. Setelah menaikkan versi, periksa dasbor, grafik, dan halaman UI Kit di mode terang maupun gelap.

Kredit

Selaras dibangun di atas karya proyek open-source yang tercantum di atas. Terima kasih kepada para pembuat dan kontributornya: Bootstrap, Tabler Icons, ApexCharts, FullCalendar, SortableJS, jQuery, DataTables, Flatpickr, Tom Select, FilePond, SweetAlert2, Quill, marked, DOMPurify, jsvectormap, Font Awesome, Bootstrap Icons, Phosphor Icons, dan huruf Plus Jakarta Sans.

Setiap pustaka tetap memakai lisensinya sendiri. Teks lisensinya disertakan di samping berkasnya di assets/vendor/.