ngx-mask
Version:
awesome ngx mask
324 lines (234 loc) • 7.39 kB
Markdown
<a href="https://jsdaddy.github.io/ngx-mask">
<h1 align="center">ngx-mask</h1>
</a>
[](https://travis-ci.org/JsDaddy/ngx-mask)
[](https://www.npmjs.com/package/ngx-mask)
<a href="https://npmjs.org/ngx-mask">
<img src="https://img.shields.io/npm/dt/ngx-mask.svg" alt="npm downloads" >
</a>
[](https://www.npmjs.com/package/ngx-mask)
[](#backers)
[](#sponsors)
[](https://github.com/JSDaddy/ngx-mask)
[](https://github.com/JSDaddy/ngx-mask)
You can also try our NGX LOADER INDICATOR [Download](https://www.npmjs.com/package/ngx-loader-indicator) it.
You can also try our NGX COPYPASTE [Download](https://www.npmjs.com/package/ngx-copypaste) it.
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/JsDaddy/ngx-mask/graphs/contributors"></a>
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/ngx-mask#backer)]
<a href="https://opencollective.com/ngx-mask#backers" target="_blank"><img src="https://opencollective.com/ngx-mask/backers.svg?width=890"></a>
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/ngx-mask#sponsor)]
```bash
$ npm install --save ngx-mask
```
Import **ngx-mask** module in Angular app.
```typescript
import {NgxMaskModule} from 'ngx-mask'
(...)
@NgModule({
(...)
imports: [
NgxMaskModule.forRoot(options)
]
(...)
})
```
Then, just define masks in inputs.
```html
<input type='text' mask='{here comes your mask}' >
```
Also you can use mask pipe
```html
<span>{{phone | mask: '(000) 000-0000'}}</span>
```
| mask | example |
| ------- | ------- |
| 9999-99-99 | 2017-04-15 |
| 0*.00 | 2017.22 |
| 000.000.000-99 | 048.457.987-98 |
| AAAA | 0F6g |
| SSSS | asDF |
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
```html
<input type='text' [specialCharacters]="[ '[' ,']' , '\\' ]" mask="[00]\[000]" >
```
```
Input value: 789-874.98
Masked value: [78]\[987]
```
```typescript
patterns ({ [character: string]: { pattern: RegExp, optional?: boolean})
```
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:
```html
<input type='text' [patterns]="customPatterns" mask="(000-000)" >
```
and in your component
```typescript
public customPatterns = {'0': { pattern: new RegExp('\[a-zA-Z\]')}};
```
```
Input value: 789HelloWorld
Masked value: (Hel-loW)
```
You can define custom pattern and specify symbol to be rendered in input field.
```typescript
pattern = {
'B': {
pattern: new RegExp('\\d'),
symbol: 'X'
}
}
```
You can add prefix to you masked value
```html
<input type='text' prefix="+7 " mask="(000) 000 00 00" >
```
You can add sufix to you masked value
```html
<input type='text' sufix=" $" mask="0000" >
```
You can choose if mask will drop special character in the model, or not, default value true
```html
<input type='text' [dropSpecialCharacters]="false" mask="000-000.00" >
```
```
Input value: 789-874.98
Model value: 789-874.98
```
You can choose if mask is shown while typing, or not, default value false
```html
<input mask="(000) 000-0000" prefix="+7" [showMaskTyped] = "true">
```
You can choose clear the input if the input value **not match** the mask, default value false
You can pass array of expression and custom Pattern to pipe
```html
<span>{{phone | mask: customMaska}}</span>
```
and in your component
```
customMaska: [string, pattern];
pattern = {
'P': {
pattern: new RegExp('\\d'),
}};
this.customMaska = ['PPP-PPP', this.pattern];
```
You can pass into mask pattern with brackets
```html
<input type='text' mask="A{4}">
```
You can devide your input by thousands
```html
<input type='text' mask="separator">
```
For separate input with dots
```html
<input type='text' mask="dot_separator">
```
For using decimals enter '.' to the end of your input to 'separator' mask and ',' to 'dot_separator'
```html
<input type='text' mask="comma_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
```
```html
<input type='text' mask="dot_separator.2">
<input type='text' mask="comma_separator.2">
<input type='text' mask="dot_separator.0">
<input type='text' mask="comma_separator.0">
```
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
```
You can validate your input as 24 hour format
```html
<input type='text' mask="Hh:m0:s0">
```
You can validate your input for percents
```html
<input type='text' mask="percent" sufix="%">
```
You can validate your formControl, default value is true
```html
<input type='text' mask="00 00" [validation]="true">
```
You can hide symbols in input field and get the actual value in formcontrol
```html
<input matInput placeholder="Secure input" [hiddenInput]="true" mask="XXX/X0/0000">
```