PaymentRequest.onshippingoptionchange
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The onshippingoptionchange
event of the PaymentRequest
interface is fired whenever the user changes a shipping option.
syntax
PaymentRequest.addEventListener('shippingaddresschange', shippingaddresschangeevent => { ... }); PaymentRequest.onshippingaddresschange = function(shippingaddresschangeevent) { ... };
Examples
The shippingoptionchange
event is triggered by a user-agent controlled interaction. If the option stored by the user agent changes at any time during a payment process, the event is triggered. To make sure an updated option is included when sending payment information to the server, you should add event listeners for a PaymentRequest
object after instantiation, but before the call to show()
.
// Initialization of PaymentRequest arguments are excerpted for clarity. var request = new PaymentRequest(supportedInstruments, details, options); // When user selects a shipping address request.addEventListener('shippingaddresschange', e => { e.updateWith(((details, addr) => { var shippingOption = { id: '', label: '', amount: { currency: 'USD', value: '0.00' }, selected: true }; // Shipping to US is supported if (addr.country === 'US') { shippingOption.id = 'us'; shippingOption.label = 'Standard shipping in US'; shippingOption.amount.value = '0.00'; details.total.amount.value = '55.00'; // Shipping to JP is supported } else if (addr.country === 'JP') { shippingOption.id = 'jp'; shippingOption.label = 'International shipping'; shippingOption.amount.value = '10.00'; details.total.amount.value = '65.00'; // Shipping to elsewhere is unsupported } else { // Empty array indicates rejection of the address details.shippingOptions = []; return Promise.resolve(details); } // Hardcode for simplicity if (details.displayItems.length === 2) { details.displayItems[2] = shippingOption; } else { details.displayItems.push(shippingOption); } details.shippingOptions = [shippingOption]; return Promise.resolve(details); })(details, request.shippingAddress)); });
Specifications
Specification | Status | Comment |
---|---|---|
Payment Request API | Working Draft | Initial definition. |
Browser Compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support |
53.0 |
? | ? | ? | ? |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | 53.0 | ? | ? | ? | ? | ? | 53.0 |
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/paymentrequest/onshippingoptionchange