EmbeddedCheckoutOptions.md

@bigcommerce/checkout-sdk / EmbeddedCheckoutOptions

Interface: EmbeddedCheckoutOptions

Table of contents

Properties

• containerId
• styles
• url

Methods

• onComplete
• onError
• onFrameError
• onFrameLoad
• onLoad
• onSignOut

Properties

containerId

• containerId: string

---

styles

• Optional styles: EmbeddedCheckoutStyles

---

url

• url: string

Methods

onComplete

▸ Optional onComplete(event): void

Parameters

Name	Type
event	EmbeddedCheckoutCompleteEvent

Returns

void

---

onError

▸ Optional onError(event): void

Parameters

Name	Type
event	EmbeddedCheckoutErrorEvent

Returns

void

---

onFrameError

▸ Optional onFrameError(event): void

Parameters

Name	Type
event	EmbeddedCheckoutFrameErrorEvent

Returns

void

---

onFrameLoad

▸ Optional onFrameLoad(event): void

Parameters

Name	Type
event	EmbeddedCheckoutFrameLoadedEvent

Returns

void

---

onLoad

▸ Optional onLoad(event): void

Parameters

Name	Type
event	EmbeddedCheckoutLoadedEvent

Returns

void

---

onSignOut

▸ Optional onSignOut(event): void

Parameters

Name	Type
event	EmbeddedCheckoutSignedOutEvent

Returns

void