react-native-credit-card-fullpage-form
v1.0.0
Published
React Native Credit Card Fullpage Form Component
Downloads
21
Maintainers
Readme
Credit Card Fullpage Form
A Component to add credit card form to your react native application. For Android & iOS.
Bifurcated from the original design for error correction
Original project: https://github.com/lexor90/react-native-credit-card-input
Code:
// fullpage with credit card flipcard
<CreditCardInput onChange={this._onChange} />
// single-line with horizontal scrolling
<LiteCreditCardInput onChange={this._onChange} />
Features
- iOS 10 form design
- Customizable credit card that flips as you type to show credit card fields (inspired by: card, react-native-credit-card)
- Scalable credit card
- Lite version for smaller screens
- Credit-card input validations & formatting as you type
- Integrated with card-validator by braintree to display credit card type
- Auto-focus next field as you complete correctly one
- iOS native form design (customizable if you want to)
Usage
npm install react-native-credit-card-fullpage-form
yarn add react-native-credit-card-fullpage-form
then add these lines in your react-native codebase
import { CreditCardInput, LiteCreditCardInput } from "react-native-credit-card-input";
<CreditCardInput onChange={this._onChange} />
// or
<LiteCreditCardInput onChange={this._onChange} />
And then on your onChange handler:
onChange => form => console.log(form);
// will print:
{
valid: true, // will be true once all fields are "valid" (time to enable the submit button)
values: { // will be in the sanitized and formatted form
number: "4242 4242",
expiry: "06/19",
cvc: "300",
type: "visa", // will be one of [null, "visa", "master-card", "american-express", "diners-club", "discover", "jcb", "unionpay", "maestro"]
name: "Sam",
postalCode: "34567",
},
status: { // will be one of ["incomplete", "invalid", and "valid"]
number: "incomplete",
expiry: "incomplete",
cvc: "incomplete",
name: "incomplete",
postalCode: "incomplete",
},
};
// Notes:
// cvc, name, & postalCode will only be available when the respective props is enabled (e.g. requiresName, requiresCVC)
Props
LiteCreditCardInput
| Property | Type | Description |
| -------- | -------- | -------- |
|autoFocus | PropTypes.bool | Automatically focus Card Number field on render|
|onChange | PropTypes.func | Receives a formData
object every time the form changes |
|onFocus | PropTypes.func | Receives the name of currently focused field |
|placeholders | PropTypes.object | Defaults to { number: "1234 5678 1234 5678", expiry: "MM/YY", cvc: "CVC" }
|
|inputStyle | Text.propTypes.style | Style for credit-card form's textInput |
|validColor | PropTypes.string | Color that will be applied for valid text input. Defaults to: "{inputStyle.color}" |
|invalidColor | PropTypes.string | Color that will be applied for invalid text input. Defaults to: "red" |
|placeholderColor | PropTypes.string | Color that will be applied for text input placeholder. Defaults to: "gray" |
NOTES
LiteCreditCardInput does not support requiresName
, requiresCVC
, and requiresPostalCode
at the moment, PRs are welcome :party:
CreditCardInput
| Property | Type | Description |
| -------- | -------- | -------- |
|autoFocus | PropTypes.bool | Automatically focus Card Number field on render|
|onChange | PropTypes.func | Receives a formData
object every time the form changes |
|onFocus | PropTypes.func | Receives the name of currently focused field |
|labels | PropTypes.object | Defaults to { number: "CARD NUMBER", expiry: "EXPIRY", cvc: "CVC/CCV" }
|
|placeholders | PropTypes.object | Defaults to { number: "1234 5678 1234 5678", expiry: "MM/YY", cvc: "CVC" }
|
|cardScale | PropTypes.number | Scales the credit-card view.Defaults to 1
, which translates to { width: 300, height: 190 }
|
|cardFontFamily | PropTypes.string | Font family for the CreditCardView, works best with monospace fonts. Defaults to Courier (iOS) or monospace (android) |
|cardImageFront | PropTypes.number | Image for the credit-card view e.g. require("./card.png")
|
|cardImageFront | PropTypes.number | Image for the credit-card view e.g. require("./card.png")
|
|labelStyle | Text.propTypes.style | Style for credit-card form's labels |
|inputStyle | Text.propTypes.style | Style for credit-card form's textInput |
|inputContainerStyle | View.propTypes.style | Style for textInput's container Defaults to: { borderBottomWidth: 1, borderBottomColor: "black" }
|
|validColor | PropTypes.string | Color that will be applied for valid text input. Defaults to: "{inputStyle.color}" |
|invalidColor | PropTypes.string | Color that will be applied for invalid text input. Defaults to: "red" |
|placeholderColor | PropTypes.string | Color that will be applied for text input placeholder. Defaults to: "gray" |
|requiresName | PropTypes.bool | Shows cardholder's name field Default to false
|
|requiresCVC | PropTypes.bool | Shows CVC field Default to true
|
|requiresPostalCode | PropTypes.bool | Shows postalCode field Default to false
|
|validatePostalCode | PropTypes.func | Function to validate postalCode, expects incomplete
, valid
, or invalid
as return values|
Methods
setValues
Set values into credit card form
// sets 4242 on credit card number field
// other fields will stay unchanged
this.refs.CCInput.setValues({ number: "4242" });
Known issues: clearing a field e.g. setValues({ expiry: "" })
will trigger the logic to move to previous field
and trigger other kind of weird side effects. PR plz
Focus
focus on to specified field
// focus to expiry field
this.refs.CCInput.focus("expiry");
Missing Something? Something is not working?
- Open a GitHub issue,
- Send a pull request,