PaymentRequest: shippingaddresschange event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The shippingaddresschange event is sent to the PaymentRequest object when the user selects a shipping address or changes details of their shipping address.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("shippingaddresschange", (event) => {});

onshippingaddresschange = (event) => {};

Event type

A PaymentRequestUpdateEvent. Inherits from Event.

Event PaymentRequestUpdateEvent

Event properties

Provides only the properties inherited from Event.

Usage notes

Depending on the browser, the shipping address information may be redacted for privacy reasons. That is, the PaymentAddress which contains the shipping address may have some portions of its content altered, obscured, or left out entirely in order to prevent identifying the user without their consent (since if they choose to have you ship products to them, you'll need their address).

Example

In this example, a handler for the shippingaddresschange event is set up to validate that the address meets requirements set by the web application.

js
const paymentRequest = new PaymentRequest(methodData, details, options);

paymentRequest.addEventListener(
  "shippingaddresschange",
  (event) => {
    let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
    event.updateWith(detailsUpdate);
  },
  false,
);

const checkAddress = (theAddress) => {
  let detailsUpdate = {};

  // Check the address, return an object with any changes or errors.

  return detailsUpdate;
};

You can also establish a handler for shippingaddresschange using the onshippingaddresschange event handler property:

js
paymentRequest.onshippingaddresschange = (event) => {
  let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
  event.updateWith(detailsUpdate);
};

Browser compatibility

BCD tables only load in the browser