AddressComponent
Beta

Last updated: July 9, 2025

Information

The AddressComponent is only available for Remember Me integrations.

Checks if the AddressComponent has captured all details from the customer.


1function isValid() {
2  return boolean;
3}

Checks if the AddressComponent can be rendered. Call this before mounting the AddressComponent.


1function isAvailable() {
2  return Promise<boolean>;
3}

Mounts an AddressComponent to a page. You can either provide:

a DOM Element Object
an Element Selector

Parameter	Type	Description
`#elem`	`object`	The Element Selector or DOM Element object to mount to


1function mount('#element') {
2  return AddressComponent;
3}

Unmounts an AddressComponent from the page.

This stops rendering the component, and removes all life-cycles from the browser.


1function unmount() {
2  return AddressComponent;
3}

Raised when an AddressComponent is initialized and ready for the customer to interact.


1const AddressComponent = checkout.create('shipping_address', {
2  onReady: (_self) => {
3
4  },
5});
6AddressComponent.mount('#address-container');

Raised when an AddressComponent changes after a customer interaction.


1const AddressComponent = checkout.create('shipping_address', {
2  onChange: (_self) => {
3
4  },
5});
6AddressComponent.mount('#address-container');

AddressComponent
Beta

Information

Methods

isValid()

isAvailable()

mount('#element')

unmount()

Events

onReady(AddressComponent)

onChange(AddressComponent)