embeddedcheckoutoptions.md

@bigcommerce/checkout-sdk › EmbeddedCheckoutOptions

Interface: EmbeddedCheckoutOptions

Hierarchy

• EmbeddedCheckoutOptions

Index

Properties

• containerId
• styles
• url

Methods

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

Properties

containerId

• containerId: string

---

Optional styles

• styles? : EmbeddedCheckoutStyles

---

url

• url: string

Methods

Optional onComplete

▸ onComplete(event: EmbeddedCheckoutCompleteEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutCompleteEvent

Returns: void

---

Optional onError

▸ onError(event: EmbeddedCheckoutErrorEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutErrorEvent

Returns: void

---

Optional onFrameError

▸ onFrameError(event: EmbeddedCheckoutFrameErrorEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutFrameErrorEvent

Returns: void

---

Optional onFrameLoad

▸ onFrameLoad(event: EmbeddedCheckoutFrameLoadedEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutFrameLoadedEvent

Returns: void

---

Optional onLoad

▸ onLoad(event: EmbeddedCheckoutLoadedEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutLoadedEvent

Returns: void

---

Optional onSignOut

▸ onSignOut(event: EmbeddedCheckoutSignedOutEvent): void

Parameters:

Name	Type
event	EmbeddedCheckoutSignedOutEvent

Returns: void