Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjayprime/react-native-dojah
This is a react native library for implementing the dojah widget gateway.
https://github.com/cjayprime/react-native-dojah
fin-tech financial messaging react services sms
Last synced: about 2 months ago
JSON representation
This is a react native library for implementing the dojah widget gateway.
- Host: GitHub
- URL: https://github.com/cjayprime/react-native-dojah
- Owner: cjayprime
- License: mit
- Created: 2020-10-02T15:44:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T13:40:56.000Z (6 months ago)
- Last Synced: 2024-11-06T16:15:53.431Z (about 2 months ago)
- Topics: fin-tech, financial, messaging, react, services, sms
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/react-dojah
- Size: 352 KB
- Stars: 0
- Watchers: 1
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-dojah
> https://github.com/cjayprime/react-native-dojah
[](https://www.npmjs.com/package/react-native-dojah) [](https://standardjs.com)
## Install
```sh
npm install react-native-dojah --save
```
or with `yarn`
```sh
yarn add react-native-dojah
```
Required Packages
## Other required installations (make sure to follow the instructions in the react-native-webview documentation)
### See https://github.com/react-native-webview/react-native-webview/issues/140#issuecomment-574185464
```sh
npm install react-native-webview react-native-permissions react-native-geolocation-service @react-native-async-storage/async-storage --save
```
# On Android
```sh
// If you would like to use the selfie, or id screens, add:
// Add the camera permission:
// Add the modify audio settings permission:
// If you would like to use the address screen, add:
```
# On iOS
```sh
// If you would like to use the selfie, or id screens, add:
permissions_path = '../node_modules/react-native-permissions/ios'
pod 'Permission-Camera', :path => "#{permissions_path}/Camera"
// If you would like to use the address screen, add:
pod 'Permission-LocationAccuracy', :path => "#{permissions_path}/LocationAccuracy"
pod 'Permission-LocationAlways', :path => "#{permissions_path}/LocationAlways"
pod 'react-native-geolocation-service', path: '../node_modules/react-native-geolocation-service'
```
## Usage
```jsx
import React from 'react'
import Dojah from 'react-native-dojah'
const App = () => {
/**
* This is your app ID
* (go to your dashboard at
* https://dojah.io/dashboard
* to create an app and retrieve it)
*/
const appID = '6000604fb87ea60035ef41bb';
/**
* This is your account public key
* (go to your dashboard at
* https://dojah.io/dashboard to
* retrieve it. You can also regenerate one)
*/
const publicKey = 'test_pk_TO6a57RT0v5QyhZmhbuLG8nZI';
/**
* This is the widget type you'd like to load
* (go to your dashboard at
* https://dojah.io/dashboard to enable different
* widget types)
*/
const type = 'liveness';
/**
* These are the configuration options
* available to you are:
* {debug: BOOL, pages: ARRAY[{page: STRING, config: OBJECT}]}
*
* The config object is as defined below
*
* NOTE: The otp and selfie options are only
* available to the `verification` widget
*/
const config = {
debug: true,
pages: [
{page: 'phone-number', config: {verification: false}},
{page: 'address'},
{
page: 'government-data',
config: {
bvn: true,
nin: false,
dl: false,
mobile: false,
otp: false,
selfie: false,
},
},
{page: 'selfie'},
{page: 'id', config: {passport: false, dl: true}},
],
};
/**
* These are the user's data to verify, options
* available to you possible options are:
* {first_name: STRING, last_name: STRING, dob: DATE STRING}
*
* NOTE: Passing all the values will automatically skip
* the user-data page (thus the commented out `last_name`)
*/
const userData = {
first_name: 'Chijioke',
last_name: '', // 'Nna'
dob: '2022-05-01',
};
/**
* These are the metadata options
* You can pass any values within the object
*/
const metadata = {
user_id: '121',
};
/**
* @param {String} responseType
* This method receives the type
* The type can only be one of:
* loading, begin, success, error, close
* @param {String} data
* This is the data from doja
*/
const response = (responseType, data) => {
console.log(responseType, data);
if (responseType === 'success') {
} else if (responseType === 'error') {
} else if (responseType === 'close') {
} else if (responseType === 'begin') {
} else if (responseType === 'loading') {
}
};
/**
* The `ViewStyle` of the outermost `View` wrapping the Dojah container
* defaults to {width: '100%', height: '100%'}
*/
const outerContainerStyle = {width: '100%', height: '100%'};
/**
* The `ViewStyle` of the `WebView` containing the Dojah connection
* This prop is passed to the WebView `style` prop
*/
const style = {};
/**
* The `ViewStyle` of the innermost `View` within the WebView
* This prop is passed to the WebView `containerStyle` prop
*/
const innerContainerStyle = {};
// The Doja library accepts 3 props and
// initiliazes the doja widget and connect process
return (
);
}
export default App
```
See the `example` folder for an implementation
## Deployment
**`REMEMBER TO CHANGE THE APP ID and PUBLIC KEY WHEN DEPLOYING TO A LIVE (PRODUCTION) ENVIRONMENT`**
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b feature/feature-name`
3. Commit your changes: `git commit -am 'Some commit message'`
4. Push to the branch: `git push origin feature/feature-name`
5. Submit a pull request 😉😉
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details