@bigcommerce/checkout-sdk 1.369.1 → 1.370.0
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/CHANGELOG.md +15 -0
- package/dist/checkout-button.d.ts +21 -1
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +22 -214
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/docs/README.md +4 -51
- package/docs/interfaces/BasePaymentInitializeOptions.md +1 -1
- package/docs/interfaces/BoltButtonInitializeOptions.md +17 -0
- package/docs/interfaces/BoltBuyNowInitializeOptions.md +29 -0
- package/docs/interfaces/WithBoltButtonInitializeOptions.md +18 -0
- package/package.json +1 -1
- package/docs/enums/PaypalCommerceFormFieldType.md +0 -50
- package/docs/interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md +0 -90
- package/docs/interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md +0 -15
- package/docs/interfaces/PaypalCommerceFormFieldKeyboardEventData.md +0 -15
- package/docs/interfaces/PaypalCommerceFormFieldOptions.md +0 -28
- package/docs/interfaces/PaypalCommerceFormFieldStylesMap.md +0 -29
- package/docs/interfaces/PaypalCommerceFormFieldValidateErrorData.md +0 -29
- package/docs/interfaces/PaypalCommerceFormFieldValidateEventData.md +0 -33
- package/docs/interfaces/PaypalCommerceFormFieldsMap.md +0 -36
- package/docs/interfaces/PaypalCommerceFormOptions.md +0 -148
- package/docs/interfaces/PaypalCommerceStoredCardFieldOptions.md +0 -43
- package/docs/interfaces/PaypalCommerceStoredCardFieldsMap.md +0 -22
package/docs/README.md
CHANGED
|
@@ -27,7 +27,6 @@
|
|
|
27
27
|
- [PaypalButtonStyleLayoutOption](enums/PaypalButtonStyleLayoutOption.md)
|
|
28
28
|
- [PaypalButtonStyleShapeOption](enums/PaypalButtonStyleShapeOption.md)
|
|
29
29
|
- [PaypalButtonStyleSizeOption](enums/PaypalButtonStyleSizeOption.md)
|
|
30
|
-
- [PaypalCommerceFormFieldType](enums/PaypalCommerceFormFieldType.md)
|
|
31
30
|
- [RadiusUnit](enums/RadiusUnit.md)
|
|
32
31
|
- [StyleButtonColor](enums/StyleButtonColor.md)
|
|
33
32
|
- [StyleButtonLabel](enums/StyleButtonLabel.md)
|
|
@@ -105,6 +104,8 @@
|
|
|
105
104
|
- [BodlEventsPayload](interfaces/BodlEventsPayload.md)
|
|
106
105
|
- [BodlService](interfaces/BodlService.md)
|
|
107
106
|
- [BodyStyles](interfaces/BodyStyles.md)
|
|
107
|
+
- [BoltButtonInitializeOptions](interfaces/BoltButtonInitializeOptions.md)
|
|
108
|
+
- [BoltBuyNowInitializeOptions](interfaces/BoltBuyNowInitializeOptions.md)
|
|
108
109
|
- [BoltCustomerInitializeOptions](interfaces/BoltCustomerInitializeOptions.md)
|
|
109
110
|
- [BoltPaymentInitializeOptions](interfaces/BoltPaymentInitializeOptions.md)
|
|
110
111
|
- [BraintreeError](interfaces/BraintreeError.md)
|
|
@@ -298,18 +299,7 @@
|
|
|
298
299
|
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
299
300
|
- [PaymentSettings](interfaces/PaymentSettings.md)
|
|
300
301
|
- [PaypalButtonInitializeOptions](interfaces/PaypalButtonInitializeOptions.md)
|
|
301
|
-
- [PaypalCommerceCreditCardPaymentInitializeOptions](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
|
|
302
|
-
- [PaypalCommerceFormFieldCardTypeChangeEventData](interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md)
|
|
303
|
-
- [PaypalCommerceFormFieldKeyboardEventData](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
304
|
-
- [PaypalCommerceFormFieldOptions](interfaces/PaypalCommerceFormFieldOptions.md)
|
|
305
|
-
- [PaypalCommerceFormFieldStylesMap](interfaces/PaypalCommerceFormFieldStylesMap.md)
|
|
306
|
-
- [PaypalCommerceFormFieldValidateErrorData](interfaces/PaypalCommerceFormFieldValidateErrorData.md)
|
|
307
|
-
- [PaypalCommerceFormFieldValidateEventData](interfaces/PaypalCommerceFormFieldValidateEventData.md)
|
|
308
|
-
- [PaypalCommerceFormFieldsMap](interfaces/PaypalCommerceFormFieldsMap.md)
|
|
309
|
-
- [PaypalCommerceFormOptions](interfaces/PaypalCommerceFormOptions.md)
|
|
310
302
|
- [PaypalCommercePaymentInitializeOptions](interfaces/PaypalCommercePaymentInitializeOptions.md)
|
|
311
|
-
- [PaypalCommerceStoredCardFieldOptions](interfaces/PaypalCommerceStoredCardFieldOptions.md)
|
|
312
|
-
- [PaypalCommerceStoredCardFieldsMap](interfaces/PaypalCommerceStoredCardFieldsMap.md)
|
|
313
303
|
- [PaypalExpressPaymentInitializeOptions](interfaces/PaypalExpressPaymentInitializeOptions.md)
|
|
314
304
|
- [PaypalFieldsStyleOptions](interfaces/PaypalFieldsStyleOptions.md)
|
|
315
305
|
- [PaypalStyleOptions](interfaces/PaypalStyleOptions.md)
|
|
@@ -376,6 +366,7 @@
|
|
|
376
366
|
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
377
367
|
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
378
368
|
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
369
|
+
- [WithBoltButtonInitializeOptions](interfaces/WithBoltButtonInitializeOptions.md)
|
|
379
370
|
- [WithBoltPaymentInitializeOptions](interfaces/WithBoltPaymentInitializeOptions.md)
|
|
380
371
|
- [WithBraintreePaypalCustomerInitializeOptions](interfaces/WithBraintreePaypalCustomerInitializeOptions.md)
|
|
381
372
|
- [WithBuyNowFeature](interfaces/WithBuyNowFeature.md)
|
|
@@ -442,11 +433,6 @@
|
|
|
442
433
|
- [OrderPayments](README.md#orderpayments)
|
|
443
434
|
- [PaymentInitializeOptions](README.md#paymentinitializeoptions)
|
|
444
435
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
445
|
-
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
446
|
-
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
447
|
-
- [PaypalCommerceFormFieldFocusEventData](README.md#paypalcommerceformfieldfocuseventdata)
|
|
448
|
-
- [PaypalCommerceFormFieldStyles](README.md#paypalcommerceformfieldstyles)
|
|
449
|
-
- [PaypalCommerceInitializeOptions](README.md#paypalcommerceinitializeoptions)
|
|
450
436
|
- [StripeElementOptions](README.md#stripeelementoptions)
|
|
451
437
|
- [StripeEventType](README.md#stripeeventtype)
|
|
452
438
|
|
|
@@ -551,7 +537,7 @@ ___
|
|
|
551
537
|
|
|
552
538
|
### CheckoutButtonInitializeOptions
|
|
553
539
|
|
|
554
|
-
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`WithPayPalCommerceInlineButtonInitializeOptions`](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md) & [`WithPayPalCommerceVenmoButtonInitializeOptions`](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
540
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithBoltButtonInitializeOptions`](interfaces/WithBoltButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`WithPayPalCommerceInlineButtonInitializeOptions`](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md) & [`WithPayPalCommerceVenmoButtonInitializeOptions`](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
555
541
|
|
|
556
542
|
___
|
|
557
543
|
|
|
@@ -730,39 +716,6 @@ ___
|
|
|
730
716
|
|
|
731
717
|
___
|
|
732
718
|
|
|
733
|
-
### PaypalCommerceFormFieldBlurEventData
|
|
734
|
-
|
|
735
|
-
Ƭ **PaypalCommerceFormFieldBlurEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
736
|
-
|
|
737
|
-
___
|
|
738
|
-
|
|
739
|
-
### PaypalCommerceFormFieldEnterEventData
|
|
740
|
-
|
|
741
|
-
Ƭ **PaypalCommerceFormFieldEnterEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
742
|
-
|
|
743
|
-
___
|
|
744
|
-
|
|
745
|
-
### PaypalCommerceFormFieldFocusEventData
|
|
746
|
-
|
|
747
|
-
Ƭ **PaypalCommerceFormFieldFocusEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
|
|
748
|
-
|
|
749
|
-
___
|
|
750
|
-
|
|
751
|
-
### PaypalCommerceFormFieldStyles
|
|
752
|
-
|
|
753
|
-
Ƭ **PaypalCommerceFormFieldStyles**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
754
|
-
|
|
755
|
-
___
|
|
756
|
-
|
|
757
|
-
### PaypalCommerceInitializeOptions
|
|
758
|
-
|
|
759
|
-
Ƭ **PaypalCommerceInitializeOptions**: [`PaypalCommercePaymentInitializeOptions`](interfaces/PaypalCommercePaymentInitializeOptions.md) \| [`PaypalCommerceCreditCardPaymentInitializeOptions`](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
|
|
760
|
-
|
|
761
|
-
A set of options that are required to initialize the PayPal Commerce payment
|
|
762
|
-
method could be used for PayPal Smart Payment Buttons or PayPal Credit Card methods.
|
|
763
|
-
|
|
764
|
-
___
|
|
765
|
-
|
|
766
719
|
### StripeElementOptions
|
|
767
720
|
|
|
768
721
|
Ƭ **StripeElementOptions**: [`CardElementOptions`](interfaces/CardElementOptions.md) \| [`CardExpiryElementOptions`](interfaces/CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](interfaces/CardNumberElementOptions.md) \| [`CardCvcElementOptions`](interfaces/CardCvcElementOptions.md) \| [`IdealElementOptions`](interfaces/IdealElementOptions.md) \| [`IbanElementOptions`](interfaces/IbanElementOptions.md) \| [`ZipCodeElementOptions`](interfaces/ZipCodeElementOptions.md)
|
|
@@ -301,7 +301,7 @@ ___
|
|
|
301
301
|
|
|
302
302
|
### paypalcommerce
|
|
303
303
|
|
|
304
|
-
• `Optional` **paypalcommerce**: [`PaypalCommercePaymentInitializeOptions`](PaypalCommercePaymentInitializeOptions.md)
|
|
304
|
+
• `Optional` **paypalcommerce**: [`PaypalCommercePaymentInitializeOptions`](PaypalCommercePaymentInitializeOptions.md)
|
|
305
305
|
|
|
306
306
|
The options that are required to initialize the PayPal Commerce payment method.
|
|
307
307
|
They can be omitted unless you need to support PayPal Commerce.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BoltButtonInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BoltButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [buyNowInitializeOptions](BoltButtonInitializeOptions.md#buynowinitializeoptions)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### buyNowInitializeOptions
|
|
14
|
+
|
|
15
|
+
• `Optional` **buyNowInitializeOptions**: [`BoltBuyNowInitializeOptions`](BoltBuyNowInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize Buy Now functionality.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BoltBuyNowInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BoltBuyNowInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [storefrontApiToken](BoltBuyNowInitializeOptions.md#storefrontapitoken)
|
|
10
|
+
|
|
11
|
+
### Methods
|
|
12
|
+
|
|
13
|
+
- [getBuyNowCartRequestBody](BoltBuyNowInitializeOptions.md#getbuynowcartrequestbody)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### storefrontApiToken
|
|
18
|
+
|
|
19
|
+
• `Optional` **storefrontApiToken**: `string`
|
|
20
|
+
|
|
21
|
+
## Methods
|
|
22
|
+
|
|
23
|
+
### getBuyNowCartRequestBody
|
|
24
|
+
|
|
25
|
+
▸ **getBuyNowCartRequestBody**(): `default`
|
|
26
|
+
|
|
27
|
+
#### Returns
|
|
28
|
+
|
|
29
|
+
`default`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithBoltButtonInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithBoltButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [bolt](WithBoltButtonInitializeOptions.md#bolt)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### bolt
|
|
14
|
+
|
|
15
|
+
• `Optional` **bolt**: [`BoltButtonInitializeOptions`](BoltButtonInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the Bolt payment
|
|
18
|
+
method. They can be omitted unless you need to support Bolt.
|
package/package.json
CHANGED
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldType
|
|
2
|
-
|
|
3
|
-
# Enumeration: PaypalCommerceFormFieldType
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumeration Members
|
|
8
|
-
|
|
9
|
-
- [CardCode](PaypalCommerceFormFieldType.md#cardcode)
|
|
10
|
-
- [CardCodeVerification](PaypalCommerceFormFieldType.md#cardcodeverification)
|
|
11
|
-
- [CardExpiry](PaypalCommerceFormFieldType.md#cardexpiry)
|
|
12
|
-
- [CardName](PaypalCommerceFormFieldType.md#cardname)
|
|
13
|
-
- [CardNumber](PaypalCommerceFormFieldType.md#cardnumber)
|
|
14
|
-
- [CardNumberVerification](PaypalCommerceFormFieldType.md#cardnumberverification)
|
|
15
|
-
|
|
16
|
-
## Enumeration Members
|
|
17
|
-
|
|
18
|
-
### CardCode
|
|
19
|
-
|
|
20
|
-
• **CardCode**
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### CardCodeVerification
|
|
25
|
-
|
|
26
|
-
• **CardCodeVerification**
|
|
27
|
-
|
|
28
|
-
___
|
|
29
|
-
|
|
30
|
-
### CardExpiry
|
|
31
|
-
|
|
32
|
-
• **CardExpiry**
|
|
33
|
-
|
|
34
|
-
___
|
|
35
|
-
|
|
36
|
-
### CardName
|
|
37
|
-
|
|
38
|
-
• **CardName**
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### CardNumber
|
|
43
|
-
|
|
44
|
-
• **CardNumber**
|
|
45
|
-
|
|
46
|
-
___
|
|
47
|
-
|
|
48
|
-
### CardNumberVerification
|
|
49
|
-
|
|
50
|
-
• **CardNumberVerification**
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceCreditCardPaymentInitializeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceCreditCardPaymentInitializeOptions
|
|
4
|
-
|
|
5
|
-
A set of options that are required to initialize the PayPal Commerce payment
|
|
6
|
-
method for presenting its credit card form.
|
|
7
|
-
|
|
8
|
-
```html
|
|
9
|
-
<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
|
|
10
|
-
<div id="card-number"></div>
|
|
11
|
-
<div id="card-name"></div>
|
|
12
|
-
<div id="card-expiry"></div>
|
|
13
|
-
<div id="card-code"></div>
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
```js
|
|
17
|
-
service.initializePayment({
|
|
18
|
-
methodId: 'paypalcommerce',
|
|
19
|
-
paypalcommerce: {
|
|
20
|
-
form: {
|
|
21
|
-
fields: {
|
|
22
|
-
cardNumber: { containerId: 'card-number' },
|
|
23
|
-
cardName: { containerId: 'card-name' },
|
|
24
|
-
cardExpiry: { containerId: 'card-expiry' },
|
|
25
|
-
cardCode: { containerId: 'card-code' },
|
|
26
|
-
},
|
|
27
|
-
},
|
|
28
|
-
},
|
|
29
|
-
});
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Additional options can be passed in to customize the fields and register
|
|
33
|
-
event callbacks.
|
|
34
|
-
|
|
35
|
-
```js
|
|
36
|
-
service.initializePayment({
|
|
37
|
-
methodId: 'paypalcommerce',
|
|
38
|
-
creditCard: {
|
|
39
|
-
form: {
|
|
40
|
-
fields: {
|
|
41
|
-
cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
|
|
42
|
-
cardName: { containerId: 'card-name', placeholder: 'Name of card' },
|
|
43
|
-
cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
|
|
44
|
-
cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
|
|
45
|
-
},
|
|
46
|
-
styles: {
|
|
47
|
-
default: {
|
|
48
|
-
color: '#000',
|
|
49
|
-
},
|
|
50
|
-
error: {
|
|
51
|
-
color: '#f00',
|
|
52
|
-
},
|
|
53
|
-
focus: {
|
|
54
|
-
color: '#0f0',
|
|
55
|
-
},
|
|
56
|
-
},
|
|
57
|
-
onBlur({ fieldType }) {
|
|
58
|
-
console.log(fieldType);
|
|
59
|
-
},
|
|
60
|
-
onFocus({ fieldType }) {
|
|
61
|
-
console.log(fieldType);
|
|
62
|
-
},
|
|
63
|
-
onEnter({ fieldType }) {
|
|
64
|
-
console.log(fieldType);
|
|
65
|
-
},
|
|
66
|
-
onCardTypeChange({ cardType }) {
|
|
67
|
-
console.log(cardType);
|
|
68
|
-
},
|
|
69
|
-
onValidate({ errors, isValid }) {
|
|
70
|
-
console.log(errors);
|
|
71
|
-
console.log(isValid);
|
|
72
|
-
},
|
|
73
|
-
},
|
|
74
|
-
},
|
|
75
|
-
});
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## Table of contents
|
|
79
|
-
|
|
80
|
-
### Properties
|
|
81
|
-
|
|
82
|
-
- [form](PaypalCommerceCreditCardPaymentInitializeOptions.md#form)
|
|
83
|
-
|
|
84
|
-
## Properties
|
|
85
|
-
|
|
86
|
-
### form
|
|
87
|
-
|
|
88
|
-
• **form**: [`PaypalCommerceFormOptions`](PaypalCommerceFormOptions.md)
|
|
89
|
-
|
|
90
|
-
The form is data for Credit Card Form
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldCardTypeChangeEventData
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldCardTypeChangeEventData
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [cardType](PaypalCommerceFormFieldCardTypeChangeEventData.md#cardtype)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### cardType
|
|
14
|
-
|
|
15
|
-
• `Optional` **cardType**: `string`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldKeyboardEventData
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldKeyboardEventData
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [fieldType](PaypalCommerceFormFieldKeyboardEventData.md#fieldtype)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### fieldType
|
|
14
|
-
|
|
15
|
-
• **fieldType**: `string`
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldOptions
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldOptions
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- **`PaypalCommerceFormFieldOptions`**
|
|
8
|
-
|
|
9
|
-
↳ [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)
|
|
10
|
-
|
|
11
|
-
## Table of contents
|
|
12
|
-
|
|
13
|
-
### Properties
|
|
14
|
-
|
|
15
|
-
- [containerId](PaypalCommerceFormFieldOptions.md#containerid)
|
|
16
|
-
- [placeholder](PaypalCommerceFormFieldOptions.md#placeholder)
|
|
17
|
-
|
|
18
|
-
## Properties
|
|
19
|
-
|
|
20
|
-
### containerId
|
|
21
|
-
|
|
22
|
-
• **containerId**: `string`
|
|
23
|
-
|
|
24
|
-
___
|
|
25
|
-
|
|
26
|
-
### placeholder
|
|
27
|
-
|
|
28
|
-
• `Optional` **placeholder**: `string`
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldStylesMap
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldStylesMap
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [default](PaypalCommerceFormFieldStylesMap.md#default)
|
|
10
|
-
- [error](PaypalCommerceFormFieldStylesMap.md#error)
|
|
11
|
-
- [focus](PaypalCommerceFormFieldStylesMap.md#focus)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### default
|
|
16
|
-
|
|
17
|
-
• `Optional` **default**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### error
|
|
22
|
-
|
|
23
|
-
• `Optional` **error**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### focus
|
|
28
|
-
|
|
29
|
-
• `Optional` **focus**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldValidateErrorData
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldValidateErrorData
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [fieldType](PaypalCommerceFormFieldValidateErrorData.md#fieldtype)
|
|
10
|
-
- [message](PaypalCommerceFormFieldValidateErrorData.md#message)
|
|
11
|
-
- [type](PaypalCommerceFormFieldValidateErrorData.md#type)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### fieldType
|
|
16
|
-
|
|
17
|
-
• **fieldType**: `string`
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### message
|
|
22
|
-
|
|
23
|
-
• **message**: `string`
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### type
|
|
28
|
-
|
|
29
|
-
• **type**: `string`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldValidateEventData
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldValidateEventData
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [errors](PaypalCommerceFormFieldValidateEventData.md#errors)
|
|
10
|
-
- [isValid](PaypalCommerceFormFieldValidateEventData.md#isvalid)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### errors
|
|
15
|
-
|
|
16
|
-
• **errors**: `Object`
|
|
17
|
-
|
|
18
|
-
#### Type declaration
|
|
19
|
-
|
|
20
|
-
| Name | Type |
|
|
21
|
-
| :------ | :------ |
|
|
22
|
-
| `cardCode?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
23
|
-
| `cardCodeVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
24
|
-
| `cardExpiry?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
25
|
-
| `cardName?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
26
|
-
| `cardNumber?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
27
|
-
| `cardNumberVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### isValid
|
|
32
|
-
|
|
33
|
-
• **isValid**: `boolean`
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldsMap
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormFieldsMap
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [cardCode](PaypalCommerceFormFieldsMap.md#cardcode)
|
|
10
|
-
- [cardExpiry](PaypalCommerceFormFieldsMap.md#cardexpiry)
|
|
11
|
-
- [cardName](PaypalCommerceFormFieldsMap.md#cardname)
|
|
12
|
-
- [cardNumber](PaypalCommerceFormFieldsMap.md#cardnumber)
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### cardCode
|
|
17
|
-
|
|
18
|
-
• `Optional` **cardCode**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
|
|
19
|
-
|
|
20
|
-
___
|
|
21
|
-
|
|
22
|
-
### cardExpiry
|
|
23
|
-
|
|
24
|
-
• **cardExpiry**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
|
|
25
|
-
|
|
26
|
-
___
|
|
27
|
-
|
|
28
|
-
### cardName
|
|
29
|
-
|
|
30
|
-
• **cardName**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
|
|
31
|
-
|
|
32
|
-
___
|
|
33
|
-
|
|
34
|
-
### cardNumber
|
|
35
|
-
|
|
36
|
-
• **cardNumber**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
|
|
@@ -1,148 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormOptions
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceFormOptions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [fields](PaypalCommerceFormOptions.md#fields)
|
|
10
|
-
- [styles](PaypalCommerceFormOptions.md#styles)
|
|
11
|
-
|
|
12
|
-
### Methods
|
|
13
|
-
|
|
14
|
-
- [onBlur](PaypalCommerceFormOptions.md#onblur)
|
|
15
|
-
- [onCardTypeChange](PaypalCommerceFormOptions.md#oncardtypechange)
|
|
16
|
-
- [onEnter](PaypalCommerceFormOptions.md#onenter)
|
|
17
|
-
- [onFocus](PaypalCommerceFormOptions.md#onfocus)
|
|
18
|
-
- [onValidate](PaypalCommerceFormOptions.md#onvalidate)
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### fields
|
|
23
|
-
|
|
24
|
-
• **fields**: [`PaypalCommerceFormFieldsMap`](PaypalCommerceFormFieldsMap.md) \| [`PaypalCommerceStoredCardFieldsMap`](PaypalCommerceStoredCardFieldsMap.md)
|
|
25
|
-
|
|
26
|
-
Containers for fields can be to present in one set of values
|
|
27
|
-
|
|
28
|
-
```js
|
|
29
|
-
{ cardNumber: { containerId: 'card-number' },
|
|
30
|
-
cardName: { containerId: 'card-name' },
|
|
31
|
-
cardExpiry: { containerId: 'card-expiry' },
|
|
32
|
-
cardCode: { containerId: 'card-code' }, }
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Or in another set of values.
|
|
36
|
-
|
|
37
|
-
```js
|
|
38
|
-
{ cardCodeVerification: { containerId: 'card-number' },
|
|
39
|
-
cardNumberVerification: { containerId: 'card-name' }, }
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
___
|
|
43
|
-
|
|
44
|
-
### styles
|
|
45
|
-
|
|
46
|
-
• `Optional` **styles**: [`PaypalCommerceFormFieldStylesMap`](PaypalCommerceFormFieldStylesMap.md)
|
|
47
|
-
|
|
48
|
-
Styles for inputs. Change the width, height and other styling.
|
|
49
|
-
|
|
50
|
-
```js
|
|
51
|
-
default: { color: '#000' },
|
|
52
|
-
error: { color: '#f00' },
|
|
53
|
-
focus: { color: '#0f0' }
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## Methods
|
|
57
|
-
|
|
58
|
-
### onBlur
|
|
59
|
-
|
|
60
|
-
▸ `Optional` **onBlur**(`data`): `void`
|
|
61
|
-
|
|
62
|
-
A callback that gets called when a field loses focus.
|
|
63
|
-
|
|
64
|
-
#### Parameters
|
|
65
|
-
|
|
66
|
-
| Name | Type |
|
|
67
|
-
| :------ | :------ |
|
|
68
|
-
| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
|
|
69
|
-
|
|
70
|
-
#### Returns
|
|
71
|
-
|
|
72
|
-
`void`
|
|
73
|
-
|
|
74
|
-
___
|
|
75
|
-
|
|
76
|
-
### onCardTypeChange
|
|
77
|
-
|
|
78
|
-
▸ `Optional` **onCardTypeChange**(`data`): `void`
|
|
79
|
-
|
|
80
|
-
A callback that gets called when activity within
|
|
81
|
-
the number field has changed such that the possible
|
|
82
|
-
card type has changed.
|
|
83
|
-
|
|
84
|
-
#### Parameters
|
|
85
|
-
|
|
86
|
-
| Name | Type |
|
|
87
|
-
| :------ | :------ |
|
|
88
|
-
| `data` | [`PaypalCommerceFormFieldCardTypeChangeEventData`](PaypalCommerceFormFieldCardTypeChangeEventData.md) |
|
|
89
|
-
|
|
90
|
-
#### Returns
|
|
91
|
-
|
|
92
|
-
`void`
|
|
93
|
-
|
|
94
|
-
___
|
|
95
|
-
|
|
96
|
-
### onEnter
|
|
97
|
-
|
|
98
|
-
▸ `Optional` **onEnter**(`data`): `void`
|
|
99
|
-
|
|
100
|
-
A callback that gets called when the user requests submission
|
|
101
|
-
of an input field, by pressing the Enter or Return key
|
|
102
|
-
on their keyboard, or mobile equivalent.
|
|
103
|
-
|
|
104
|
-
#### Parameters
|
|
105
|
-
|
|
106
|
-
| Name | Type |
|
|
107
|
-
| :------ | :------ |
|
|
108
|
-
| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
|
|
109
|
-
|
|
110
|
-
#### Returns
|
|
111
|
-
|
|
112
|
-
`void`
|
|
113
|
-
|
|
114
|
-
___
|
|
115
|
-
|
|
116
|
-
### onFocus
|
|
117
|
-
|
|
118
|
-
▸ `Optional` **onFocus**(`data`): `void`
|
|
119
|
-
|
|
120
|
-
A callback that gets called when a field gains focus.
|
|
121
|
-
|
|
122
|
-
#### Parameters
|
|
123
|
-
|
|
124
|
-
| Name | Type |
|
|
125
|
-
| :------ | :------ |
|
|
126
|
-
| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
|
|
127
|
-
|
|
128
|
-
#### Returns
|
|
129
|
-
|
|
130
|
-
`void`
|
|
131
|
-
|
|
132
|
-
___
|
|
133
|
-
|
|
134
|
-
### onValidate
|
|
135
|
-
|
|
136
|
-
▸ `Optional` **onValidate**(`data`): `void`
|
|
137
|
-
|
|
138
|
-
A callback that gets called when the validity of a field has changed.
|
|
139
|
-
|
|
140
|
-
#### Parameters
|
|
141
|
-
|
|
142
|
-
| Name | Type |
|
|
143
|
-
| :------ | :------ |
|
|
144
|
-
| `data` | [`PaypalCommerceFormFieldValidateEventData`](PaypalCommerceFormFieldValidateEventData.md) |
|
|
145
|
-
|
|
146
|
-
#### Returns
|
|
147
|
-
|
|
148
|
-
`void`
|