https://github.com/bhrott/react-native-masked-text
A pure javascript masked text and input text component for React-Native.
https://github.com/bhrott/react-native-masked-text
input mask react-native
Last synced: 3 months ago
JSON representation
A pure javascript masked text and input text component for React-Native.
- Host: GitHub
- URL: https://github.com/bhrott/react-native-masked-text
- Owner: bhrott
- License: mit
- Created: 2016-10-04T17:41:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T07:33:12.000Z (11 months ago)
- Last Synced: 2025-12-15T04:24:29.036Z (3 months ago)
- Topics: input, mask, react-native
- Language: JavaScript
- Homepage:
- Size: 127 MB
- Stars: 1,609
- Watchers: 23
- Forks: 250
- Open Issues: 103
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-masked-text ★392 - A simple masked text and input text component for React Native. (Components / UI)
README
# react-native-masked-text
[](https://www.codetriage.com/benhurott/react-native-masked-text)
This is a simple masked text (normal text and input text) component for React-Native.
## Alert
Hey guys!
Unfortunatelly I'm not developing js apps anymore. This repo will not receive updates anymore.
## 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:
```jsx
import { TextInputMask } from 'react-native-masked-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](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/CelPhone.js)):
```jsx
{
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:
```jsx
{
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](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/Cpf.js)):
```jsx
{
this.setState({
cpf: text
})
}}
/>
```
#### Methods
You can check if the cpf is valid by calling the `isValid()` method:
```jsx
{
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:
```jsx
const unmasked = this.cpfField.getRawValue()
// in the mask: 123.456.789-01
// unmasked: 12345678901
```
### CNPJ
Mask: `99.999.999/9999-99`
Sample code ([source](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/Cnpj.js)):
```jsx
{
this.setState({
cnpj: text
})
}}
/>
```
#### Methods
You can check if the cnpj is valid by calling the `isValid()` method:
```jsx
{
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:
```jsx
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` or `9999 **** **** 9999` (obfuscated)
- amex: `9999 999999 99999` or `9999 ****** 99999` (obfuscated)
- diners: `9999 999999 9999` or `9999 ****** 9999` (obfuscated)
Sample code ([source](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/CreditCard.js))
```jsx
{
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:
```jsx
{
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](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/Custom.js)):
```jsx
//
// SIMPLE
//
{
this.setState({
text: text
})
}}
style={textInputStype}
/>
//
// ADVANCED
//
= 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](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/Datetime.js)):
```jsx
{
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:
```jsx
{
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](https://momentjs.com/) object from the date if it's valid calling the `getRawValue` method:
```jsx
const momentDate = this.datetimeField.getRawValue()
```
### Money
Mask: `R$999,99` (fully customizable)
Sample code ([source](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/Money.js)):
```jsx
// SIMPLE
{
this.setState({
simple: text
})
}}
/>
// ADVANCED
{
this.setState({
advanced: text
})
}}
/>
```
#### Options
| name | type | required | default | description |
| ---------- | ------- | -------- | -------------------- | ----------- |
| precision | number | no | `2` | The number of cents to show |
| separator | string | no | `,` | The cents separator |
| delimiter | string | no | `.` | The thousand separator |
| unit | string | no | `R$` | The prefix text |
| suffixUnit | string | no | `''` | The sufix text |
#### Methods
You can get the `number` value of the mask calling the `getRawValue` method:
```jsx
{
this.setState({
simple: text
})
}}
// add the ref to a local var
ref={(ref) => this.moneyField = ref}
/>
const numberValue = this.moneyField.getRawValue()
console.log(numberValue) // Number
// CAUTION: the javascript do not support giant numbers.
// so, if you have a big number in this mask, you could have problems with the value...
```
### Only Numbers
Mask: `accept only numbers`
Sample code ([source](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/OnlyNumbers.js)):
```jsx
{
this.setState({
value: text
})
}}
/>
```
### Zip Code
Mask: `99999-999`
Sample code ([source](https://github.com/benhurott/react-native-masked-text-samples/blob/master/ReactNativeMaskedTextSamples/Samples/OnlyNumbers.js)):
```jsx
{
this.setState({
value: text
})
}}
/>
```
#### Methods
You can get the `unmasked` value using the `getRawValue` method:
```jsx
{
this.setState({
value: text
})
}}
// add the ref to a local var
ref={(ref) => this.zipCodeField = ref}
/>
//...
const unmasked = this.zipCodeField.getRawValue()
// in the mask: 98765-321
// unmasked: 98765321
```
### ... Utils
#### Including the `rawText` in `onChangeText` [1.12.0+]
If you need the raw value in every text change, you can use the `includeRawValueInChangeText`.
It will provide the masked and the raw text in every text change.
```jsx
{
// maskedText: 123.456.789-01
// rawText: 12345678901
}}
/>
```
#### Getting the `TextInput` instance
If you want to get the `TextInput` raw component, use the `getElement()` method:
```jsx
{
this.setState({
value: text
})
}}
// add the ref to a local var
ref={(ref) => this.zipCodeField = ref}
/>
//...
const textInput = this.zipCodeField.getElement()
```
#### Blocking user to add character
If you want, you can block a value to be added to the text using the `checkText` prop:
```jsx
{
return next === 'your valid value or other boolean condition';
}
}
/>
```
#### Using custom text inputs
You can use this prop if you want custom text input instead native TextInput component:
```jsx
const Textfield = MKTextField.textfield()
.withPlaceholder('Text...')
.withStyle(styles.textfield)
.build();
```
#### About the normal text input props
You can use all the normal TextInput props from React-Native, with this in mind:
- onChangeText is intercepted by component.
- value is intercepted by component.
- if you pass keyboardType, it will override the keyboardType of masked component.
#### Code Samples
If you want, you can check the code samples in this repo:
[react-native-masked-text-samples](https://github.com/benhurott/react-native-masked-text-samples)
## Usage (TextMask)
```jsx
import React, { Component } from 'react'
// import the component
import { TextMask } from 'react-native-masked-text'
export default class MyComponent extends Component {
constructor(props) {
super(props)
this.state = {
text: '4567123409871234'
}
}
render() {
// the type is required but options is required only for some specific types.
// the sample below will output 4567 **** **** 1234
return (
)
}
}
```
### Props
The same of _TextInputMask_, but for React-Native _Text_ component instead _TextInput_.
_Warning_: if the value not match the mask, it will not appear.
### Methods
`getElement()`: return the instance of _Text_ component.
## Extra (MaskService)
If you want, we expose the `MaskService`. You can use it:
**Methods**
- static toMask(type, value, settings): mask a value.
- `type` (String, required): the type of the mask (`cpf`, `datetime`, etc...)
- `value` (String, required): the value to be masked
- `settings` (Object, optional): if the mask type accepts options, pass it in the settings parameter
- static toRawValue(type, maskedValue, settings): get the raw value of a masked value.
- `type` (String, required): the type of the mask (`cpf`, `datetime`, etc...)
- `maskedValue` (String, required): the masked value to be converted in raw value
- `settings` (Object, optional): if the mask type accepts options, pass it in the settings parameter
- static isValid(type, value, settings): validate if the mask and the value match.
- `type` (String, required): the type of the mask (`cpf`, `datetime`, etc...)
- `value` (String, required): the value to be masked
- `settings` (Object, optional): if the mask type accepts options, pass it in the settings parameter
- static getMask(type, value, settings): get the mask used to mask the value
Ex:
```jsx
import { MaskService } from 'react-native-masked-text'
var money = MaskService.toMask('money', '123', {
unit: 'US$',
separator: '.',
delimiter: ','
})
// money -> US$ 1.23
```
## Throubleshooting
- If the `es2015` error throw by babel, try run `react-native start --reset-cache`
## Changelog
View changelog [HERE](CHANGELOG.md)
## Thanks to
-
- Thanks to [vanilla-masker](https://github.com/BankFacil/vanilla-masker) =).
- Thanks to [moment](http://momentjs.com/) =).