WARNING: from version 17.1.0 onwards, this package will be moved to @ngx-iban/ngx-iban

ngx-iban

This Angular (7+) module consists of three parts:

1. a directive to use in template-driven forms;
2. a validator to use in reactive forms;
3. a pipe to transform a string to the IBAN format (groups of 4 characters)

An optional ISO 3166-1 alpha-2 country code can be passed as a parameter to both the directive and the validator. When given, validation also checks if the entered IBAN is valid for that specific country.

You can see a live demo of the module here.

Installation

You can install ngx-iban via:

npm install ibantools ngx-iban --save

or

yarn add ibantools ngx-iban

Compatibility table

Usage

import { NgModule } from "@angular/core";
import { NgxIbanModule } from "ngx-iban";

@NgModule({
  imports: [NgxIbanModule]
})
export class AppModule {}

Template-driven forms

<form>
  <input type="text" [(ngModel)]="iban" ngxIban>

  <!-- Or with an ISO 3166-1 alpha-2 country code -->
  <input type="text" [(ngModel)]="iban" ngxIban="NL">
</form>

Reactive forms

import { Component } from "@angular/core";
import { FormControl } from "@angular/forms";
import { ibanValidator } from "ngx-iban";

@Component({
  selector: "my-component",
  styleUrls: ["./my.component.scss"],
  templateUrl: "./my.component.html"
})
export class MyComponent {
  iban = new FormControl("", ibanValidator());

  // Or with an ISO 3166-1 alpha-2 country code
  iban = new FormControl("", ibanValidator("NL"));
}

<form>
  <input type="text" [formControl]="iban">
</form>

Pipe

<span>{{ 'GB82WEST12345698765432' | iban }}</span>

becomes

<span>GB82 WEST 1234 5698 7654 32</span>