@bigcommerce/checkout-sdk 1.245.0 → 1.245.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/README.md CHANGED
@@ -337,6 +337,7 @@
337
337
  * [WithCheckoutcomiDealInstrument](interfaces/withcheckoutcomidealinstrument.md)
338
338
  * [WithDocumentInstrument](interfaces/withdocumentinstrument.md)
339
339
  * [WithMollieIssuerInstrument](interfaces/withmollieissuerinstrument.md)
340
+ * [WorldpayPaymentInitializeOptions](interfaces/worldpaypaymentinitializeoptions.md)
340
341
  * [ZipCodeElementOptions](interfaces/zipcodeelementoptions.md)
341
342
 
342
343
  ### Type aliases
@@ -55,6 +55,7 @@ current checkout flow.
55
55
  * [stripeupe](paymentinitializeoptions.md#optional-stripeupe)
56
56
  * [stripev3](paymentinitializeoptions.md#optional-stripev3)
57
57
  * [timeout](paymentinitializeoptions.md#optional-timeout)
58
+ * [worldpay](paymentinitializeoptions.md#optional-worldpay)
58
59
 
59
60
  ## Properties
60
61
 
@@ -390,3 +391,12 @@ ___
390
391
  Provide this option if you want to cancel or time out the request. If the
391
392
  timeout object completes before the request, the request will be
392
393
  cancelled.
394
+
395
+ ___
396
+
397
+ ### `Optional` worldpay
398
+
399
+ • **worldpay**? : *[WorldpayPaymentInitializeOptions](worldpaypaymentinitializeoptions.md)*
400
+
401
+ The options that are required to initialize the Worldpay payment method.
402
+ They can be omitted unless you need to support Worldpay.
@@ -0,0 +1,39 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) › [WorldpayPaymentInitializeOptions](worldpaypaymentinitializeoptions.md)
2
+
3
+ # Interface: WorldpayPaymentInitializeOptions
4
+
5
+ ## Hierarchy
6
+
7
+ * **WorldpayPaymentInitializeOptions**
8
+
9
+ ## Index
10
+
11
+ ### Methods
12
+
13
+ * [onLoad](worldpaypaymentinitializeoptions.md#onload)
14
+
15
+ ## Methods
16
+
17
+ ### onLoad
18
+
19
+ ▸ **onLoad**(`iframe`: HTMLIFrameElement, `cancel`: function): *void*
20
+
21
+ A callback that gets called when the iframe is ready to be added to the
22
+ current page. It is responsible for determining where the iframe should
23
+ be inserted in the DOM.
24
+
25
+ **Parameters:**
26
+
27
+ ▪ **iframe**: *HTMLIFrameElement*
28
+
29
+ The iframe element containing the payment web page
30
+ provided by the strategy.
31
+
32
+ ▪ **cancel**: *function*
33
+
34
+ A function, when called, will cancel the payment
35
+ process and remove the iframe.
36
+
37
+ ▸ (): *void*
38
+
39
+ **Returns:** *void*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.245.0",
3
+ "version": "1.245.1",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",