@sezzle/sezzle-react-widget 2.0.0 → 2.0.3

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/README.md CHANGED
@@ -1,16 +1,27 @@
1
1
  [![Sezzle](https://media.sezzle.com/branding/2.0/png/Logo_FullColor_250x63.png)]()
2
2
 
3
- `sezzle-react-widget` is a react based component to render Sezzle's widget on react platforms.
3
+ `@sezzle/sezzle-react-widget` is a React-based component to render Sezzle's widget on React platforms.
4
4
 
5
- # Usage
5
+ # Installation
6
6
  ______________________________________________________________________
7
- `var SezzleWidget = require('sezzle-react-widget')`
8
7
 
9
- If you use ES modules:
8
+ Using npm:
9
+ `npm install @sezzle/sezzle-react-widget`
10
10
 
11
- `import SezzleWidget from 'sezzle-react-widget'`
11
+ Within your product page, add the two following snippets in the appropriate locations:
12
12
 
13
- # Available Props
13
+ `import SezzleWidget from '@sezzle/sezzle-react-widget'`
14
+
15
+ ```
16
+ <SezzleWidget
17
+ price={YOUR PRICE VARIABLE HERE}
18
+ merchantId={'YOUR MERCHANT ID HERE'}
19
+ />
20
+ ```
21
+
22
+ # Customization
23
+
24
+ The following props can be specified in the element to customize the widget's content and appearance
14
25
  ______________________________________________________________________
15
26
  - **{price} (Required)**
16
27
  - Type: String
@@ -64,19 +75,18 @@ ______________________________________________________________________
64
75
  # Example
65
76
 
66
77
  ```
67
- <SezzleWidget config={
68
- {
69
- price: '$29.99',
70
- merchantId: '12a34bc5-6de7-890f-g123-4hi5678jk901',
71
- theme: 'light',
72
- alignment: 'auto',
73
- fontWeight: '500',
74
- fontFamily: 'inherit',
75
- fontSize: 14,
76
- textColor: 'inherit',
77
- logoSize: 1,
78
- includeAPModal: true,
79
- minPrice: 35
80
- }
81
- }/>
78
+ <SezzleWidget
79
+ price={'$29.99'}
80
+ merchantId={'12a34bc5-6de7-890f-g123-4hi5678jk901'}
81
+ theme={'light'}
82
+ includeAPModal={false}
83
+ minPrice={35}
84
+ fontWeight={500}
85
+ fontFamily={'inherit'}
86
+ fontSize={12}
87
+ textColor={'inherit'}
88
+ alignment={'auto'}
89
+ logoSize={1}
90
+ />
91
+
82
92
  ```