@bigcommerce/checkout-sdk 1.341.0 → 1.343.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 +14 -0
- 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 +11 -3
- 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 +7 -0
- package/docs/interfaces/CheckoutSettings.md +1 -7
- package/docs/interfaces/CheckoutStoreSelector.md +15 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -432,6 +432,7 @@
|
|
|
432
432
|
- [StripeElementOptions](README.md#stripeelementoptions)
|
|
433
433
|
- [StripeEventType](README.md#stripeeventtype)
|
|
434
434
|
- [UserExperienceSettingNames](README.md#userexperiencesettingnames)
|
|
435
|
+
- [UserExperienceSettings](README.md#userexperiencesettings)
|
|
435
436
|
|
|
436
437
|
### Functions
|
|
437
438
|
|
|
@@ -732,6 +733,12 @@ ___
|
|
|
732
733
|
|
|
733
734
|
Ƭ **UserExperienceSettingNames**: ``"walletButtonsOnTop"``
|
|
734
735
|
|
|
736
|
+
___
|
|
737
|
+
|
|
738
|
+
### UserExperienceSettings
|
|
739
|
+
|
|
740
|
+
Ƭ **UserExperienceSettings**: { [key in UserExperienceSettingNames]: boolean }
|
|
741
|
+
|
|
735
742
|
## Functions
|
|
736
743
|
|
|
737
744
|
### createBodlService
|
|
@@ -45,13 +45,7 @@ ___
|
|
|
45
45
|
|
|
46
46
|
### checkoutUserExperienceSettings
|
|
47
47
|
|
|
48
|
-
• **checkoutUserExperienceSettings**: `
|
|
49
|
-
|
|
50
|
-
#### Type declaration
|
|
51
|
-
|
|
52
|
-
| Name | Type |
|
|
53
|
-
| :------ | :------ |
|
|
54
|
-
| `walletButtonsOnTop` | `boolean` |
|
|
48
|
+
• **checkoutUserExperienceSettings**: [`UserExperienceSettings`](../README.md#userexperiencesettings)
|
|
55
49
|
|
|
56
50
|
___
|
|
57
51
|
|
|
@@ -35,6 +35,7 @@ checkout information, such as shipping and billing details.
|
|
|
35
35
|
- [getShippingCountries](CheckoutStoreSelector.md#getshippingcountries)
|
|
36
36
|
- [getShippingOptions](CheckoutStoreSelector.md#getshippingoptions)
|
|
37
37
|
- [getSignInEmail](CheckoutStoreSelector.md#getsigninemail)
|
|
38
|
+
- [getUserExperienceSettings](CheckoutStoreSelector.md#getuserexperiencesettings)
|
|
38
39
|
- [isPaymentDataRequired](CheckoutStoreSelector.md#ispaymentdatarequired)
|
|
39
40
|
- [isPaymentDataSubmitted](CheckoutStoreSelector.md#ispaymentdatasubmitted)
|
|
40
41
|
|
|
@@ -447,6 +448,20 @@ The sign-in email object if sent, otherwise undefined
|
|
|
447
448
|
|
|
448
449
|
___
|
|
449
450
|
|
|
451
|
+
### getUserExperienceSettings
|
|
452
|
+
|
|
453
|
+
▸ **getUserExperienceSettings**(): `undefined` \| [`UserExperienceSettings`](../README.md#userexperiencesettings)
|
|
454
|
+
|
|
455
|
+
Gets user experience settings.
|
|
456
|
+
|
|
457
|
+
#### Returns
|
|
458
|
+
|
|
459
|
+
`undefined` \| [`UserExperienceSettings`](../README.md#userexperiencesettings)
|
|
460
|
+
|
|
461
|
+
The object of user experience settings if it is loaded, otherwise undefined.
|
|
462
|
+
|
|
463
|
+
___
|
|
464
|
+
|
|
450
465
|
### isPaymentDataRequired
|
|
451
466
|
|
|
452
467
|
▸ **isPaymentDataRequired**(`useStoreCredit?`): `boolean`
|