README
react-native-masked-text
This is a simple masked text (normal text and input text) component for React-Native.
Supported Versions
React-native: 0.32.0 or higher
Install
npm install react-native-masked-text --save
Usage (TextInputMask)
For all the masks you will use in this way:
import { TextInputMask } from 'react-native-masked-text'
//...
<TextInputMask
type={'type-of-the-mask'}
options={
{
// the options for your mask if needed
}
}
// dont forget to set the "value" and "onChangeText" props
value={this.state.text}
onChangeText={text => {
this.setState({
text: text
})
}}
/>
Cel Phone
Mask:
- BRL (default):
(99) 9999-9999
or(99) 99999-9999
(will detect automatically) - INTERNATIONAL:
+999 999 999 999
If you need a different formatting, use the Custom
mask =).
Sample code (source):
<TextInputMask
type={'cel-phone'}
options={{
maskType: 'BRL',
withDDD: true,
dddMask: '(99) '
}}
value={this.state.international}
onChangeText={text => {
this.setState({
international: text
})
}}
/>
Options
name | type | required | default | description |
---|---|---|---|---|
maskType | string | no | maskType |
the type of the mask to use. Available: BRL or INTERNATIONAL |
withDDD | boolean | no | true |
if the mask type is BRL , include the DDD |
dddMask | string | no | (99) |
if the mask type is BRL , the DDD mask |
Methods
You can get the unmasked
value using the getRawValue
method:
<TextInputMask
type={'cel-phone'}
options={{
maskType: 'BRL',
withDDD: true,
dddMask: '(99) '
}}
value={this.state.international}
onChangeText={text => {
this.setState({
international: text
})
}}
// add the ref to a local var
ref={(ref) => this.phoneField = ref}
/>
//...
const unmasked = this.phoneField.getRawValue()
// in the mask: (51) 98765-4321
// unmasked: 51987654321
CPF
Mask: 999.999.999-99
Sample code (source):
<TextInputMask
type={'cpf'}
value={this.state.cpf}
onChangeText={text => {
this.setState({
cpf: text
})
}}
/>
Methods
You can check if the cpf is valid by calling the isValid()
method:
<TextInputMask
type={'cpf'}
value={this.state.cpf}
onChangeText={text => {
this.setState({
cpf: text
})
}}
// add the ref to a local var
ref={(ref) => this.cpfField = ref}
/>
// get the validation
const cpfIsValid = this.cpfField.isValid()
console.log(cpfIsValid) // boolean
You can get the unmasked
cpf calling the getRawValue
method:
const unmasked = this.cpfField.getRawValue()
// in the mask: 123.456.789-01
// unmasked: 12345678901
CNPJ
Mask: 99.999.999/9999-99
Sample code (source):
<TextInputMask
type={'cnpj'}
value={this.state.cnpj}
onChangeText={text => {
this.setState({
cnpj: text
})
}}
/>
Methods
You can check if the cnpj is valid by calling the isValid()
method:
<TextInputMask
type={'cnpj'}
value={this.state.cnpj}
onChangeText={text => {
this.setState({
cnpj: text
})
}}
// add the ref to a local var
ref={(ref) => this.cnpjField = ref}
/>
// get the validation
const cnpjIsValid = this.cnpjField.isValid()
console.log(cnpjIsValid) // boolean
You can get the unmasked
cpf calling the getRawValue
method:
const unmasked = this.cnpjField.getRawValue()
// in the mask: 99.999.999/9999-99
// unmasked: 99999999999999
Credit Card
Mask:
- visa or master:
9999 9999 9999 9999
or9999 **** **** 9999
(obfuscated) - amex:
9999 999999 99999
or9999 ****** 99999
(obfuscated) - diners:
9999 999999 9999
or9999 ****** 9999
(obfuscated)
Sample code (source)
<TextInputMask
type={'credit-card'}
options={{
obfuscated: false,
issuer: 'amex'
}}
value={this.state.creditCard}
onChangeText={text => {
this.setState({
creditCard: text
})
}}
/>
Options
name | type | required | default | description |
---|---|---|---|---|
obfuscated | boolean | no | false |
if the mask should be obfuscated or not |
issuer | string | no | visa-or-mastercard |
the type of the card mask. The options are: visa-or-mastercard , amex or diners |
Methods
You can get the array containing the groups of the value value using the getRawValue
method:
<TextInputMask
type={'credit-card'}
options={{
obfuscated: false,
issuer: 'amex'
}}
value={this.state.creditCard}
onChangeText={text => {
this.setState({
creditCard: text
})
}}
// add the ref to a local var
ref={(ref) => this.creditCardField = ref}
/>
//...
const unmasked = this.creditCardField.getRawValue()
// in the mask: 9874 6541 3210 9874
// unmasked: [9874, 6541, 3210, 9874]
Custom
Mask: defined by pattern
9
- accept digit.A
- accept alpha.S
- accept alphanumeric.*
- accept all, EXCEPT white space.
Ex: AAA-9999
Sample code (source):
//
// SIMPLE
//
<TextInputMask
type={'custom'}
options={{
/**
* mask: (String | required | default '')
* the mask pattern
* 9 - accept digit.
* A - accept alpha.
* S - accept alphanumeric.
* * - accept all, EXCEPT white space.
*/
mask: '999 AAA SSS ***'
}}
value={this.state.text}
onChangeText={text => {
this.setState({
text: text
})
}}
style={textInputStype}
/>
//
// ADVANCED
//
<TextInputMask
type={'custom'}
options={{
// required
/**
* mask: (String | required | default '')
* the mask pattern
* 9 - accept digit.
* A - accept alpha.
* S - accept alphanumeric.
* * - accept all, EXCEPT white space.
*/
mask: '999 AAA SSS ***',
// optional
/**
* validator: (Function | optional | defaults returns true)
* use this funcion to inform if the inputed value is a valid value (for invalid phone numbers, for example). The isValid method use this validator.
*/
validator: function(value, settings) {
return true
},
/**
* getRawValue: (Function | optional | defaults return current masked value)
* use this function to parse and return values to use what you want.
* for example, if you want to create a phone number mask (999) 999-99-99 but want to get only
* the numbers for value, use this method for this parse step.
*/
getRawValue: function(value, settings) {
return 'my converted value';
},
/**
* translation: (Object | optional | defaults 9, A, S, *)
* the dictionary that translate mask and value.
* you can change defaults by simple override the key (9, A, S, *) or create some new.
*/
translation: {
// this is a custom translation. The others (9, A, S, *) still works.
// this translation will be merged and turns into 9, A, S, *, #.
'#': function(val) {
if (val === ' ') {
return val;
}
// if returns null, undefined or '' (empty string), the value will be ignored.
return null;
},
// in this case, we will override build-in * translation (allow all characters)
// and set this to allow only blank spaces and some special characters.
'*': function(val) {
return [' ', '#', ',', '.', '!'].indexOf(val) >= 0 ? val : null;
}
}
}}
value={this.state.text}
onChangeText={text => {
this.setState({
text: text
})
}}
style={textInputStype}
/>
Options
name | type | required | default | description |
---|---|---|---|---|
mask | string | YES | The mask pattern | |
validator | function | no | function that returns true |
the function that's validate the value in the mask |
getRawValue | function | no | return current value | function to parsed value (like unmasked or converted) |
translation | object (map{string,function}) | no | 9 - digit , A - alpha , S - alphanumeric , * - all, except space |
The translator to use in the pattern |
Datetime
Mask:
DD/MM/YYYY HH:mm:ss
DD/MM/YYYY
MM/DD/YYYY
YYYY/MM/DD
HH:mm:ss
HH:mm
HH
You can use -
instead of /
if you want.
Sample code (source):
<TextInputMask
type={'datetime'}
options={{
format: 'YYYY/MM/DD'
}}
value={this.state.dt}
onChangeText={text => {
this.setState({
dt: text
})
}}
/>
Options
name | type | required | default | description |
---|---|---|---|---|
format | string | YES | The date format to be validated |
Methods
You can check if the date is valid by calling the isValid()
method:
<TextInputMask
type={'datetime'}
options={{
format: 'YYYY/MM/DD'
}}
value={this.state.dt}
onChangeText={text => {
this.setState({
dt: text
})
}}
// add the ref to a local var
ref={(ref) => this.datetimeField = ref}
/>
// get the validation
const isValid = this.datetimeField.isValid()
console.log(isValid) // boolean
You can get the moment object from the date if it's valid calling the getRawValue
method:
const momentDate = this.datetimeField.getRawValue()
Money
Mask: R$999,99
(fully customizable)
Sample code (source):
// SIMPLE
<TextInputMask
type={'money'}
value={this.state.simple}
onChangeText={text => {
this.setState({
simple: text
})
}}
/>
// ADVANCED
<TextInputMask
type={'money'}
options={{
precision: 2,
separator: ',',
delimiter: '.',
unit: 'R