ngx-mask
You can also try our NGX LOADER INDICATOR Download it. You can also try our NGX COPYPASTE Download it.
documentation with examples.
You can see the fullCredits
Contributors
This project exists thanks to all the people who contribute. [Contribute].
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Installing
$ npm install --save ngx-mask
Quickstart
Import ngx-mask module in Angular app.
;
Then, just define masks in inputs.
Usage
Also you can use mask pipe
Usage
{{phone | mask: '(000) 000-0000'}}
Examples
mask | example |
---|---|
9999-99-99 | 2017-04-15 |
0*.00 | 2017.22 |
000.000.000-99 | 048.457.987-98 |
AAAA | 0F6g |
SSSS | asDF |
Mask Options
You can define your custom options for all directives (as object in the mask module) or for each (as attributes for directive). If you override this parameter, you have to provide all the special characters (default one are not included).
specialCharacters (string[ ])
We have next default characters:
character |
---|
/ |
( |
) |
. |
: |
- |
space |
+ |
, |
@ |
Usage
Then:
Input value: 789-874.98
Masked value: [78]\[987]
patterns
We have next default patterns:
code | meaning |
---|---|
0 | digits (like 0 to 9 numbers) |
9 | digits (like 0 to 9 numbers), but optional |
A | letters (uppercase or lowercase) and digits |
S | only letters (uppercase or lowercase) |
Usage:
and in your component
public customPatterns =;
Then:
Input value: 789HelloWorld
Masked value: (Hel-loW)
Custom pattern for this
You can define custom pattern and specify symbol to be rendered in input field.
pattern =
prefix (string)
You can add prefix to you masked value
Usage
suffix (string)
You can add suffix to you masked value
Usage
dropSpecialCharacters (boolean)
You can choose if mask will drop special character in the model, or not, default value true
Usage
Then:
Input value: 789-874.98
Model value: 789-874.98
showMaskTyped (boolean)
You can choose if mask is shown while typing, or not, default value false
Usage
clearIfNotMatch (boolean)
You can choose clear the input if the input value not match the mask, default value false
Pipe with mask expression and custom Pattern ([string, pattern])
You can pass array of expression and custom Pattern to pipe
Usage
{{phone | mask: customMaska}}
and in your component
customMaska: [string, pattern];
pattern = {
'P': {
pattern: new RegExp('\\d'),
}};
this.customMaska = ['PPP-PPP', this.pattern];
Repeat mask
You can pass into mask pattern with brackets
Usage
Thousand separator
You can devide your input by thousands
Usage
For separate input with dots
For using decimals enter '.' to the end of your input to 'separator' mask and ',' to 'dot_separator'
For using decimals enter '.' to the end of your input to 'separator' or 'comma_separator' mask and ',' to 'dot_separator'
Input value: 1234.56
Masked value: 1 234.56
Input value: 1234,56
Masked value: 1.234,56
Input value: 1234.56
Masked value: 1,234.56
For limiting decimal precision add '.' and the precision you want to limit too on the input. 2 is useful for currency. 0 will prevent decimals completely.
Input value: 1234,56
Masked value: 1.234,56
Input value: 1234.56
Masked value: 1,234.56
Input value: 1234,56
Masked value: 1.234
Input value: 1234.56
Masked value: 1,234
Time validation
You can validate your input as 24 hour format
Usage
Percent validation
You can validate your input for percents
Usage
FormControl validation
You can validate your formControl, default value is true
Usage
Secure input
You can hide symbols in input field and get the actual value in formcontrol
Usage
IP valid mask
Usage