[](https://travis-ci.org/JsDaddy/ngx-mask)
[](https://www.npmjs.com/package/ngx-mask)
[](https://www.npmjs.com/package/ngx-mask)
## Installing
```bash
$ npm install --save ngx-mask-2
```
## Quickstart
Import **ngx-mask-2** module in Angular app.
```typescript
import {NgxMaskModule} from 'ngx-mask-2'
(...)
@NgModule({
(...)
imports: [
NgxMaskModule.forRoot(options)
]
(...)
})
```
Then, just define masks in inputs.
#### Usage
```html
```
Also you can use mask pipe
#### Usage
```html
{{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)
### specialCharacters (string[ ])
We have next default characters:
| character |
|-----------|
| / |
| ( |
| ) |
| . |
| : |
| - |
| **space** |
| + |
| , |
| @ |
##### Usage
```html
```
##### Then:
```
Input value: 789-874.98
Masked value: [78]\[987]
```
### 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
```
and in your component
```typescript
public customPatterns = {'0': { pattern: new RegExp('\[a-zA-Z\]')}};
```
##### Then:
```
Input value: 789HelloWorld
Masked value: (Hel-loW)
```
### prefix (string)
You can add prefix to you masked value
##### Usage
```html
```
### appendPrefixToModel (boolean)
You can choose to append prefix value to NgModel, default value false
##### Usage
```html
```
### sufix (string)
You can add sufix to you masked value
##### Usage
```html
```
### dropSpecialCharacters (boolean)
You can choose if mask will drop special character in the model, or not, default value true
##### Usage
```html
```
##### 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
```html
```
### 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
```html
{{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
```html
```
## Examples
Check the [demo](https://jsdaddy.github.io/ngx-mask/).
