ngx-cleave-directive

Angular Cleave Directive

This directive integrates cleave.js into Angular Form.

It lies on a simple fact that Angular listens to input event to bring the view-to-model binding into being.

* According to the description of updateOn property of AbstractControlOptions interface, when updateOn is set to blur or submit, Angular listens to blur or submit event for model update. In this directive, update-on-blur case is handled in a hack way. No further processing is required for update-on-submit case.

Since extra input and blur events are dispatched, if you bind a callback to input event or blur event, the callback will be invoked twice on input or blur.

To overcome the disadvantage, a debounced function is recommended for the event binding.

The directive works with Angular 5+.

Usage

1.Install cleave.js and ngx-cleave-directive.

npm i -S cleave.js ngx-cleave-directive

2.Import NgxCleaveDirectiveModule to your Angular module.

import { NgxCleaveDirectiveModule } from 'ngx-cleave-directive';
@NgModule({
  imports: [
    ...
    NgxCleaveDirectiveModule,
    ...
  ],
  ...

3.Add the "cleave" attribute to an input element or a textarea element and bind it with a legal cleave.js option.

<input type="text" ... [cleave]="{creditCard: true}">

Note: The cleave directive should be used with the ngModel, formControl or formControlName directives.

4.Import any cleave.js addon if needed.

e.g.

import 'cleave.js/dist/addons/cleave-phone.au-cn.js';

5.Cleave.js version compatibility

Cleave.js	ngx-cleave-directive
1.3.7 ~ 1.5.0	1.0.x
1.5.1 ~ 1.5.1	1.1.x
1.6.0+	2.0.x

For more details, please refer to cleave.js official site.

Version History

• 2.0.0 Ivy Compatibility
• 1.1 Cleave 1.5.1+ Compatibility
• 1.0 Initial Version

---

Good luck.