Reference
Halaman ini merangkum atribut, header, event, ekstensi, dan opsi konfigurasi yang tersedia pada Uji Lengkap. Gunakan tabel di bawah sebagai rujukan cepat saat membangun antarmuka.
Attributes
Atribut berikut dapat dipasang pada elemen HTML untuk mengaktifkan perilaku request dan penukaran respons.
| Attribute | Description |
|---|---|
hx-get | Mengirim HTTP GET request ke URL yang ditentukan dan menukar respons ke dalam DOM. |
hx-post | Mengirim HTTP POST request ke URL yang ditentukan dan menukar respons ke dalam DOM. |
hx-put | Mengirim HTTP PUT request ke URL yang ditentukan dan menukar respons ke dalam DOM. |
hx-patch | Mengirim HTTP PATCH request ke URL yang ditentukan dan menukar respons ke dalam DOM. |
hx-delete | Mengirim HTTP DELETE request ke URL yang ditentukan dan menukar respons ke dalam DOM. |
hx-swap | Menentukan bagaimana respons ditukar ke dalam DOM, misalnya innerHTML, outerHTML, beforeend, atau none. |
hx-target | Menentukan elemen yang menjadi target penukaran respons, menggunakan selector CSS atau kata kunci khusus. |
hx-trigger | Menentukan event yang memicu request, misalnya click, change, atau custom event. |
hx-vals | Menambahkan nilai tambahan ke parameter request dalam bentuk JSON. |
hx-include | Menyertakan nilai dari elemen lain ke dalam parameter request. |
hx-indicator | Menentukan elemen indikator loading yang ditampilkan selama request berlangsung. |
hx-confirm | Menampilkan dialog konfirmasi sebelum request dikirim. |
hx-push-url | Mendorong URL baru ke history browser setelah request berhasil. |
hx-select | Memilih sebagian konten dari respons untuk ditukar ke dalam DOM. |
hx-boost | Meningkatkan link dan form biasa agar menggunakan AJAX secara otomatis. |
Headers
Header request dan respons berikut digunakan untuk berkomunikasi antara klien dan server.
| Header | Description |
|---|---|
HX-Request | Header yang dikirim pada setiap request untuk menandakan bahwa request berasal dari Uji Lengkap. |
HX-Trigger | Header respons yang memicu event pada sisi klien setelah respons diterima. |
HX-Trigger-After-Settle | Header respons yang memicu event setelah proses settle selesai. |
HX-Trigger-After-Swap | Header respons yang memicu event setelah proses swap selesai. |
HX-Redirect | Header respons yang memerintahkan browser untuk melakukan redirect. |
HX-Refresh | Header respons yang memerintahkan browser untuk melakukan refresh halaman. |
HX-Retarget | Header respons yang mengganti target penukaran respons. |
HX-Reswap | Header respons yang mengganti strategi swap untuk respons tersebut. |
Events
Event berikut dapat digunakan pada atribut hx-trigger untuk memicu request.
| Event | Description |
|---|---|
load | Dipicu ketika elemen dimuat, berguna untuk memulai request secara otomatis. |
click | Dipicu ketika elemen diklik, event default untuk tombol dan link. |
change | Dipicu ketika nilai input berubah, umum digunakan pada form dan select. |
submit | Dipicu ketika form dikirim, menggantikan perilaku submit bawaan. |
revealed | Dipicu ketika elemen memasuki viewport, berguna untuk lazy loading. |
intersect | Dipicu ketika elemen berpotongan dengan viewport sesuai konfigurasi. |
keyup | Dipicu ketika tombol keyboard dilepas, sering dipakai untuk pencarian langsung. |
every | Memungkinkan request berulang pada interval waktu tertentu. |
Extensions
Ekstensi menambahkan kemampuan baru di atas perilaku inti Uji Lengkap.
| Extension | Description |
|---|---|
json-enc | Mengirim parameter request dalam format JSON alih-alih form encoding. |
morphdom-swap | Menggunakan morphdom untuk melakukan swap DOM yang lebih halus. |
client-side-templates | Merender respons menggunakan template sisi klien seperti mustache atau nunjucks. |
path-deps | Memungkinkan request dipicu ketika path tertentu berubah. |
restored | Memulihkan state halaman ketika pengguna menekan tombol back. |
Configuration
Opsi konfigurasi berikut dapat diatur melalui meta atau JavaScript untuk menyesuaikan perilaku default.
| Option | Description |
|---|---|
defaultSwapStyle | Strategi swap default yang digunakan ketika hx-swap tidak ditentukan. |
defaultSwapDelay | Jeda default dalam milidetik sebelum proses swap dilakukan. |
defaultSettleDelay | Jeda default dalam milidetik sebelum proses settle dilakukan. |
historyCacheSize | Jumlah maksimum entri cache history yang disimpan. |
includeIndicatorStyles | Menentukan apakah style indikator loading disertakan secara otomatis. |
timeout | Batas waktu default untuk request dalam milidetik. |