sbx-react-cashier
v1.4.30
Published
Payments widget with states like deposit, withdrawal or payments history for sbx client. Only for sbx inner use.
Downloads
41
Readme
Payments widget
Payments widget with states like deposit, withdrawal or payments history for sbx client. Only for sbx inner use.
Requirements
node >= 4.1
sbx >=0.3.55
Core dependencies
packages 'sbx-client-request' must be installed;
package 'sbx-client-form' must be installed;
package 'sbx-client-table' must be installed;
Installation
$ sbx install sbx-react-cashier
Use widget
import Cashier from 'sbx-react-cashier';
//add to any React component like a child
<SomeComponent>
<Cashier {...props}/>
</SomeComponent>
###Props
What props this widget has
####General props | Name | Type | Required | Description | |------|------|----------|-------------| | rest | string | true | API endpoint for cashier | | platform | string | true | Specify on what sbx platform do you use this widget. Values: 'forex', 'crypto' or 'etc'.| | accountId | number | true | Account for deposit, withdrawal or viewing transactions Values: 'forex', 'crypto' or 'etc'. | | page | string | false | Specify witch page of widget do you need to display: 'deposit','depositHistory', 'withdrawal' or 'withdrawalHistory' Default is 'deposit'| | user | Object | false | You can throw user data by your self. If you dont - widget will go to user service and get user info automatically| | styles | styleObject | false | Specify custom colors | | onChange | function | false | returns Object with two string params 'type' - 'deposit' or 'withdrawal' and 'status': - event status. This function fires on widget steps changing|
styleObject
| color | default color | Description | |------|------|-------------| | --primary | 'blue' | Color for effects and buttons | | --active-primary | 'green' | Color for focused and active button | | --danger | 'red' | Color for error button and error messages | | --bg | 'white' | Main background color | | --bg-contrast | 'grey' | Contrast background for main background | | --color | 'black' | Maim text color | | --color-contrast | 'white' | Text color for contrast colors and colored buttons |
Developers
FAQ
License
The MIT License (MIT)
Copyright (c) 2021 Sobix Group LLC