AuthenticationComponent
Beta

Last updated: July 7, 2025

Information

The AuthenticationComponent is only available for Remember Me integrations.

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


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

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


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

Mounts an AuthenticationComponent 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 AuthenticationComponent;
3}

Unmounts an AuthenticationComponent from the page.

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


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

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


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

Raised when an AuthenticationComponent changes after a customer interaction.


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

AuthenticationComponent
Beta

Information

Methods

isValid()

isAvailable()

mount('#element')

unmount()

Events

onReady(AuthenticationComponent)

onChange(AuthenticationComponent)