pfrendo / ngx-mask Goto Github PK

$ npm install --save ngx-mask

Import ngx-mask module in Angular app.

import {NgxMaskModule} from 'ngx-mask'

(...)

@NgModule({
  (...)
  imports: [
    NgxMaskModule.forRoot(options)
  ]
  (...)
})

Then, just define masks in inputs.

<input type='text' mask='{here comes your mask}' >

You can define your custom options for all directives (as object in the mask module) or for each (as attributes for directive)

We have next default characters:

<input type='text' specialCharacters="[ '[' ,']' , '*' ]" mask="[00]*[000]" >

Input value: 789-874.98
Masked value: [78]*[987]

We have next default patterns:

<input type='text' patterns="{'0': { pattern: new RegExp('\[a-zA-Z\]')}}" mask="(000-000)" >

Input value: 789HelloWorld
Masked value: (Hel-loW)

You can choose if mask will drop special character in the model, or not, default value true

<input type='text' dropSpecialCharacters="false" mask="000-000.00" >

Input value: 789-874.98
Model value: 789-874.98

You can choose clear the input if the input value not match the mask, default value false

Check the demo.