Create Card Expiry Date Element

createElement('expiry', options?)

Use this function to create an instance of an individual Element.

Parameters

typerequired'expiry'

The type of element you are creating.

optionsoptionalExpiryElementOptions

Options for creating expiry Element.

Returns

ExpiryElement | null
linkTypeScript
1import { createElement } from '@airwallex/components-sdk';
2const element = createElement('expiry');

ExpiryElementOptions

Applies to split card element type integration, the interface used when createElement() with type expiry.

disabledoptionalboolean

Whether the expiry Element input is disabled or not. Default value is false.

placeholderoptionalstring

A short hint to suggest the expected value of an input field to the shopper.

styleoptional
InputStyle

Style for the expiry Element.

ExpiryElement

Functions and external fields can be used in your integration flow with Airwallex element

blur()

Using this function to blur the HTML Input element.

Returns

void
linkTypeScript
1element.blur();

clear()

Using this function to clear the HTML Input element.

Returns

void
linkTypeScript
1element.clear();

destroy()

Destroys the Element instance.

Returns

void
linkTypeScript
1element.destroy();

focus()

Using this function to focus the HTML Input element

Returns

void
linkTypeScript
1element.focus();

mount(domElement)

Mounts Element to your HTML DOM.

Parameters

domElementrequiredstring | HTMLElement

Returns

null | HTMLElement
linkTypeScript
1// There are two ways to mount the element:
2// 1. Call with the container DOM id
3element.mount('container-dom-id');
4

5// 2. Find the created DOM in the existing HTML and call with the container DOM element
6const containerElement = document.getElementById('container-dom-id');
7element.mount(containerElement);

on(event, handler)

Listen to element event

Parameters

eventrequired
ExpiryElementEvent

handlerrequiredEventListener

Returns

void
linkTypeScript
1element.on('change', () => {
2  // Handle change event
3});

unmount()

Unmounts the Element. Note that the Element instance will remain.

Returns

void
linkTypeScript
1element.unmount();

update(options?, initOptions?)

Using this function to update the element option after create the element.

Parameters

optionsoptionalPartial<
ExpiryDateElementOptions
>

initOptionsoptionalPartial<
InitOptions
>

Returns

void
linkTypeScript
1element.update({
2  placeholder: 'replace-with-your-placeholder',
3});