Skip to content

Latest commit

 

History

History
112 lines (67 loc) · 2.74 KB

HostedField.md

File metadata and controls

112 lines (67 loc) · 2.74 KB

@bigcommerce/checkout-sdk / HostedField

Class: HostedField

Table of contents

Constructors

Methods

Constructors

constructor

• new HostedField(_type, _containerId, _placeholder, _accessibilityLabel, _styles, _eventPoster, _eventListener, _detachmentObserver, _cardInstrument?)

Parameters

Name Type
_type HostedFieldType
_containerId string
_placeholder string
_accessibilityLabel string
_styles HostedFieldStylesMap
_eventPoster IframeEventPoster<HostedFieldEvent, undefined>
_eventListener IframeEventListener<HostedInputEventMap, undefined>
_detachmentObserver DetachmentObserver
_cardInstrument? CardInstrument

Methods

attach

▸ attach(): Promise<void>

Returns

Promise<void>

detach

▸ detach(): void

Returns

void

getType

▸ getType(): HostedFieldType

Returns

HostedFieldType

submitForm

▸ submitForm(fields, data): Promise<HostedInputSubmitSuccessEvent>

Parameters

Name Type
fields HostedFieldType[]
data HostedFormOrderData

Returns

Promise<HostedInputSubmitSuccessEvent>

submitStoredCardForm

▸ submitStoredCardForm(fields, data): Promise<HostedInputStoredCardSucceededEvent>

Parameters

Name Type
fields StoredCardHostedFormInstrumentFields
data StoredCardHostedFormData

Returns

Promise<HostedInputStoredCardSucceededEvent>

validateForm

▸ validateForm(): Promise<void>

Returns

Promise<void>