@mxenabled/connect-widget 0.0.1 → 0.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 +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Connect Widget
|
|
2
2
|
|
|
3
|
-
|
|
4
4
|
|
|
5
5
|
This is the **UI only** for the connect widget. Heavy configuration and an API are needed for this project to work. See [usage](#usage) and [props](#props) for more details.
|
|
6
6
|
|
|
@@ -9,17 +9,17 @@ This is the **UI only** for the connect widget. Heavy configuration and an API a
|
|
|
9
9
|
Install using npm package manager:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npm install connect-widget
|
|
12
|
+
npm install @mxenabled/connect-widget
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
|
-
1. Install package: `npm install --save connect-widget`
|
|
17
|
+
1. Install package: `npm install --save @mxenabled/connect-widget`
|
|
18
18
|
2. Import `ApiProvider` and `ConnectWidget`. Add both to your project.
|
|
19
19
|
3. Pass applicable props to widget and your API to the provider.
|
|
20
20
|
|
|
21
21
|
```jsx
|
|
22
|
-
import ConnectWidget, { ApiProvider } from 'connect-widget'
|
|
22
|
+
import ConnectWidget, { ApiProvider } from '@mxenabled/connect-widget'
|
|
23
23
|
import apiService from './apiService' // You custom api service
|
|
24
24
|
|
|
25
25
|
const App = () => {
|
|
@@ -66,7 +66,7 @@ You need to pass an object containing API endpoint callbacks as the `apiValue` p
|
|
|
66
66
|
For developing this package locally, we suggest you use npm link to connect your local version of the package to your client app using the package.
|
|
67
67
|
|
|
68
68
|
1. In the npm package root, run `npm link`.
|
|
69
|
-
2. Then in your consumer project, run `npm link connect-widget`.
|
|
69
|
+
2. Then in your consumer project, run `npm link @mxenabled/connect-widget`.
|
|
70
70
|
|
|
71
71
|
This will link the local package to your project in the node modules. Unlink the package when you are finished or if you run into issues.
|
|
72
72
|
|