react-native-mask-input

React Native Masked Text Input

A simple and effective Text Input with mask for ReactNative on iOS and Android. No fancy stuff, it's basically a JavaScript function that allow you to use custom masks easily.

Features

• Highly custom masks with the use of RegExp
• Characteres obfuscation!
• It's just a <TextInput/> component, as I said, no fancy stuff
• Use React Native ES6 and React Hooks
• Exports the function that do all the magic: formatWithMask

Installation

npm install react-native-masked-text-input

or

yarn add react-native-masked-text-input

Usage

import MaskedTextInput from 'react-native-masked-text-input';

function MyComponent() {
  const [phone, setPhone] = React.useState('');

  return (
    <MaskedTextInput
      value={phone}
      onChangeValue={(masked, unmasked) => {
        setPhone(masked); // you can use the unmasked value as well

        // assuming you type "9" all the way, in example:
        console.log(masked); // (99) 99999-9999
        console.log(unmasked); // 99999999999
      }}
      mask={[
        '(',
        /\d/, // that's because I want it to be a digit (0-9)
        /\d/,
        ')',
        ' ',
        /\d/,
        /\d/,
        /\d/,
        /\d/,
        /\d/,
        '-',
        /\d/,
        /\d/,
        /\d/,
        /\d/,
      ]}
    />
  );
}

Props

Prop	Type	Default	Description
...TextInputProps			Inherit all props of TextInput.
value	number		The value for controlled input. REQUIRED
onChangeText	function		Callback that is called when the input's text changes. differently of the default function, this one receive three arguments: (maskedText, unmaskedText, obfuscatedText) => void REQUIRED
mask	Mask		An array where each item defines one character of the value. If the item is a string, that string will be used, if it is an RegExp, it will validate the input on it.
showObfuscatedValue	boolean	false	Whether or not to display the obfuscated value on the TextInput.
placeholderFillCharacter*	string	"_"	Character to be used as the "fill character" on the default placeholder value.
obfuscationCharacter	string	"*"	Character to be used on the obfuscated characteres.

Mask

An array where each item defines one character of the value. If the item is a string, that string will be used, if it is an RegExp, it will validate the input on it.

To be clear: All the characters you want to be inputed by the user must be a Regex in your mask.

If you want a mask for Zip Code, for example, you'd do like this:

const mask = [/\d/, /\d/, /\d/, /\d/, /\d/, '-', /\d/, /\d/, /\d/];

That's because the RegExp /\d/ accepts any digit character (0-9)

Example

See EXAMPLE

git clone https://github.com/caioquirinomedeiros/react-native-masked-text-input.git
cd react-native-masked-text-input/example
yarn
yarn android / yarn ios

formatWithMask(options)

import { formatWithMask, Masks } from 'react-native-masked-text-input';

const creditCard = '9999999999999999';

const { masked, unmasked, obfuscated } = formatWithMask({
  text: phone,
  mask: Masks.CREDIT_CARD,
  obfuscationCharacter: '-',
});

console.log(masked); // 9999 9999 9999 9999
console.log(unmasked); // 9999999999999999
console.log(obfuscated); // 9999 ---- ---- 9999

options

Name	Type	Default	Description
text	string		Text to be formatted with the mask.
mask	Mask		An array where each item defines one character of the value. If the item is a string, that string will be used, if it is an RegExp, it will validate the input on it.
obfuscationCharacter	string	"*"	Character to be used on the obfuscated characteres.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

react-native-masked-text-input is released under the MIT license. See LICENSE for details.

Any question or support will welcome.