Package Exports
- react-input-mask
- react-input-mask/dist/react-input-mask
- react-input-mask/lib
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-input-mask) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-input-mask
Yet another React component for input masking. Simple and made with attention to UX. Compatible with IE8.
Demo
Install
npm install react-input-mask --save
Also you can use it without module bundler
<!-- Load React first -->
<script src="https://unpkg.com/react/dist/react.min.js"></script>
<script src="https://unpkg.com/react-dom/dist/react-dom.min.js"></script>
<!-- Will be exported to window.ReactInputMask -->
<script src="https://unpkg.com/react-input-mask/dist/react-input-mask.min.js"></script>
Properties
mask
: string
Mask string. Format characters are:
9
: 0-9
a
: A-Z, a-z
*
: A-Z, a-z, 0-9
Any character can be escaped with backslash, which usually will appear as double backslash in JS strings. For example, German phone mask with unremoveable prefix +49 will look like mask="+4\9 99 999 99"
or mask={"+4\\9 99 999 99"}
maskChar
: string
Character to cover unfilled editable parts of mask. Default character is "_". If set to null or empty string, unfilled parts will be empty, like in ordinary input.
formatChars
: object
Defines format characters with characters as keys and corresponding RegExp string as values. Default ones:
{
"9": "[0-9]",
"a": "[A-Za-z]",
"*": "[A-Za-z0-9]"
}
alwaysShowMask
: boolean
Show mask even in empty input without focus.
Example
import React from 'react';
import InputMask from 'react-input-mask';
class PhoneInput extends React.Component {
render() {
return <InputMask {...this.props} mask="+4\9 99 999 99" maskChar=" " />;
}
}
Thanks
Thanks to BrowserStack for help with testing on real devices