Händelser
De fem händelserna som appen utlöser i butiken, var och en med ett genomarbetat exempel.
Appen utlöser de här händelserna på document, så lyssna med document.addEventListener. Lägg koden i en tematillgång, eller i theme.liquid ovanför </body>.
| Händelse | detail | Utlöses när |
|---|---|---|
gpoRenderCompleted | { form, product } | Alternativen har renderats klart |
gpoElementChanged | {} | Kunden har ändrat ett alternativ |
gpoProductPriceUpdated | {} | Det visade priset har räknats om |
gpoValidated | { success } | Valideringen kördes vid Lägg i varukorgen |
gpoAddedToCart | {} | Artikeln och dess tillägg har hamnat i varukorgen |
gpoRenderCompleted
Utlöses när alternativfälten finns i DOM:en. Det är den här du ska bygga på. Appen renderar asynkront, så kod som körs vid DOMContentLoaded körs innan alternativen finns och hittar ingenting.
detail innehåller form, produktformuläret som alternativen renderades i, och product, produkten de renderades för.
document.addEventListener('gpoRenderCompleted', function (event) { const { form, product } = event.detail; if (!form) return; // ingen alternativuppsättning gäller för den här produkten
// Nu går det säkert att söka efter alternativfälten form.querySelectorAll('.gpo-form__group').forEach(function (group) { group.classList.add('my-theme-option'); });});Den utlöses igen varje gång alternativen renderas om – efter ett variantbyte i teman som renderar om produkten, eller efter att du anropat GPOConfigs.initialize(). Skriv hanteraren så att det inte gör något om den körs två gånger.
gpoElementChanged
Utlöses varje gång kunden ändrar ett alternativ: skriver i ett fält, väljer ett färgprov, markerar en kryssruta.
document.addEventListener('gpoElementChanged', function () { const engraving = document.querySelector('[name="properties[Engraving text]"]'); const note = document.querySelector('.my-engraving-note'); if (!engraving || !note) return;
note.hidden = engraving.value.trim() === '';});Den utlöses vid varje tangenttryckning i ett textfält, så använd debounce för allt som är tungt – en nätverksbegäran, en tung omlayout.
gpoProductPriceUpdated
Utlöses efter att appen har skrivit om det visade priset så att det inkluderar alternativen kunden valt. Använd den för att hålla din egen prisvisning i takt – en fast prisrad, ett sammanfattningsblock, en uppskattning av delbetalning.
document.addEventListener('gpoProductPriceUpdated', function () { const main = document.querySelector('[data-gpo-product-unit-price]'); const sticky = document.querySelector('.my-sticky-bar .price'); if (main && sticky) sticky.textContent = main.textContent;});Priset som visas på sidan är en förhandsvisning. Det kunden faktiskt debiteras tillämpas av Shopify i kassan, så behandla aldrig den här siffran som slutbeloppet. Se Så tillämpas priserna.
gpoValidated
Utlöses när kunden försöker lägga i varukorgen och appen har kontrollerat alternativen. detail.success är false när något är fel – ett obligatoriskt alternativ är tomt, en teckengräns har överskridits, för få val har gjorts.
document.addEventListener('gpoValidated', function (event) { if (event.detail.success) return;
// Läggningen i varukorgen blockerades if (window.analytics) { window.analytics.track('Option validation failed', { product: window.GPOConfigs?.product?.handle }); }});Appen rullar redan till det första felet när Rulla automatiskt till första felmeddelandet är på, så du behöver inte göra det själv. Se Widgetbeteende.
gpoAddedToCart
Utlöses efter att artikeln och eventuella tilläggsprodukter har lagts till. Det är först här som varukorgen verkligen har ändrats, vilket gör det till rätt ställe för att öppna varukorgen och för analys.
document.addEventListener('gpoAddedToCart', function () { fetch(window.Shopify.routes.root + 'cart.js') .then(function (res) { return res.json(); }) .then(function (cart) { document.querySelector('.my-cart-count').textContent = cart.item_count; });});Ett tillägg som bygger på en produkt är en egen varukorgsrad, så en enda läggning i varukorgen kan lägga till flera rader. Läs in varukorgen igen i stället för att anta att en artikel lades till. Se Slå ihop huvudprodukt och tillägg.
Att tänka på
- Alla fem kräver att appinbäddningen är aktiverad. Utan den körs appen aldrig och ingenting utlöses.
- Händelserna innehåller inga kunduppgifter utöver det som redan finns på sidan. Läs window.GPOConfigs för produkt, varukorg och kund.
- Kod du kopplar här är din att underhålla, och den är det första du ska kontrollera när butiken beter sig konstigt efter en tema- eller appuppdatering.
Was this helpful?
Thanks for your feedback! Tell us what was missing
Report an issue