@sezzle/sezzle-react-widget 3.1.6 → 3.1.7

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.
Files changed (6) hide show
  1. package/README.md +57 -48
  2. package/dist/index.cjs +463 -533
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.es.js +463 -533
  5. package/dist/index.es.js.map +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -26,78 +26,80 @@ The following props can be specified in the element to customize the widget's co
26
26
 
27
27
  ---
28
28
 
29
- - **{price} (Required)**
29
+ `price` (required)
30
30
 
31
- - Type: String
31
+ **Purpose**: The price value from which to calculate the installment amount, including currency.
32
+ **Type**: string
32
33
 
33
- - **{merchantId} (Required)**
34
+ `merchantId` (required)
34
35
 
35
- - Purpose: Site's 36-character Merchant ID, found in the Business Settings of Sezzle Merchant Dashboard.
36
- - Type: String
36
+ **Purpose**: Site's 36-character Merchant ID, found in the Business Settings of Sezzle Merchant Dashboard.
37
+ **Type**: string
37
38
 
38
- - **{theme}** (Optional)
39
+ `theme` (optional)
39
40
 
40
- - Purpose: To control the Sezzle image variant. Use light or black-flat for light backgrounds, dark or white-flat for dark backgrounds.
41
- - Type: String
42
- - Options: light, dark, white-flat, black-flat
43
- - Default: light
41
+ **Purpose**: To control the Sezzle image variant. Use light or black-flat for light backgrounds, dark or white-flat for dark backgrounds.
42
+ **Type**: string
43
+ **Options**: light, dark, white-flat, black-flat
44
+ **Default**: light
44
45
 
45
- - **{alignment}** (Optional)
46
+ `alignment` (optional)
46
47
 
47
- - Type: String
48
- - Options: auto, left, center, right
49
- - Default: auto
48
+ **Type**: string
49
+ **Options**: auto, left, center, right
50
+ **Default**: auto
50
51
 
51
- - **{fontWeight}** (Optional)
52
+ `fontWeight` (optional)
52
53
 
53
- - Type: Number
54
- - Default: 500
54
+ **Type**: number
55
+ **Default**: 500
55
56
 
56
- - **{fontFamily}** (Optional)
57
+ `fontFamily` (optional)
57
58
 
58
- - Type: String
59
- - Default: inherit
59
+ **Type**: string
60
+ **Default**: inherit
60
61
 
61
- - **{fontSize}** (Optional)
62
+ `fontSize` (optional)
62
63
 
63
- - Type: Number
64
- - Default: 14
64
+ **Type**: number
65
+ **Default**: 14
65
66
 
66
- - **{textColor}** (Optional)
67
+ `textColor` (optional)
67
68
 
68
- - Type: String
69
- - Default: inherit
69
+ **Type**: string
70
+ **Default**: inherit
70
71
 
71
- - **{logoSize}** (Optional)
72
+ `logoSize` (optional)
72
73
 
73
- - Purpose: To scale the logo (1 = 100%)
74
- - Type: Number
75
- - Default: 1
74
+ **Purpose**: To scale the logo (1 = 100%)
75
+ **Type**: number
76
+ **Default**: 1
76
77
 
77
- - **{includeAPModal}** (Optional)
78
+ `includeAPModal` (optional)
78
79
 
79
- - Purpose: To enable Afterpay's logo within the Sezzle widget
80
- - Type: Boolean
81
- - Default: false
80
+ **Purpose**: To enable Afterpay's logo within the Sezzle widget
81
+ **Type**: boolean
82
+ **Default**: false
82
83
 
83
- - **{numberOfPayments}** (Optional)
84
+ `numberOfPayments` (optional)
84
85
 
85
- - Purpose: Number of installments by which the shopper will pay the total, calculates installment amount.
86
- - Type: Number
87
- - Options: 4, 5
88
- - Default: 5
86
+ **Purpose**: Number of installments by which the shopper will pay the total, calculates installment amount.
87
+ **Type**: number
88
+ **Options**: 4, 5
89
+ **Default**: 5
90
+ **Additional Details**: Default 5 installments will appear above $50, and 4 installments will show below that amount. If override reflects `4`, 5 installments will never show in the widget or modal.
89
91
 
90
- - **{minPrice}** (Optional)
92
+ `minPrice` (optional)
91
93
 
92
- - Purpose to display a checkout minimum within the Sezzle widget
93
- - Type: Number
94
- - Default: 20
94
+ **Purpose**: to display a checkout minimum within the Sezzle widget
95
+ **Type**: number
96
+ **Default**: 0
95
97
 
96
- - **{maxPrice}** (Optional)
98
+ `maxPrice` (optional)
97
99
 
98
- - Purpose to display a checkout maximum within the Sezzle widget
99
- - Type: Number
100
- - Default: 2500
100
+ **Purpose**: the threshold at which to not show biweekly installments within the Sezzle widget
101
+ **Type**: number
102
+ **Default**: 2500
101
103
 
102
104
  ## <b>The following are reserved for merchants enrolled in our long-term payment program. Please discuss with Sezzle point of contact before using the below config options:</b>
103
105
 
@@ -106,7 +108,14 @@ The following props can be specified in the element to customize the widget's co
106
108
  **Purpose**: Minimum price for which purchase is eligible for long-term lending. Above this amount, the monthly installments with interest will be reflected in the widget and modal. Below this amount, the 4-pay widget and modal will render.
107
109
  **Type**: number
108
110
  **Default**: 0
109
- **Additional Details**: The `maxPrice` option should be overwritten to `15000` for long-term.
111
+ **Additional Details**: This is the primary indicator that long-term installments should be reflected in the widget.
112
+
113
+ `maxPriceLT` (optional)
114
+
115
+ **Purpose**: Maximum price for which purchase is eligible for long-term lending. Above this amount, the widget will not render.
116
+ **Type**: number
117
+ **Default**: 15000
118
+ **Additional Details**: Previously, `maxPrice` would be overridden. Now that field should only be used for biweekly installment maximum, and this should be used for long-term.
110
119
 
111
120
  `bestAPR` (optional)
112
121