ng2-rut
v0.3.2
Published
RUT for Angular 2
Downloads
944
Readme
Angular 2 RUT
Angular 2 library with several components to handle Chilean RUT validation, cleaning and formatting.
Installation
yarn add ng2-rut
# or
npm install ng2-rut --save
Usage
Set-up:
The easiest way to use this library is to import Ng2Rut in your app's main module.
import { NgModule } from '@angular/core';
import { Ng2Rut } from 'ng2-rut';
import { BrowserModule } from '@angular/platform-browser';
@NgModule({
...
imports: [
BrowserModule,
Ng2Rut
],
})
class DemoAppModule { }
See ./demo
folder for a fully working example.
Using it:
ng2-rut exposes multiple features that can be used to perform input validation and formatting. Probably you want to use one of the following:
RutValidator
: Exposes thevalidateRut
directive (to attach to models or inputs) and the RutValidator class to be used asValidator
on reactive forms.RutPipe
: Exposes theRutPipe
pipe to format rut numbers on templatesRutDirective
: Exposes theformatRut
directive to format RUT inputs.
RutValidator
Reactive forms
import { FormGroup, FormBuilder, Validators, FormControl } from '@angular/forms';
export class DemoAppComponent {
constructor (fb: FormBuilder, rutValidator: RutValidator) {
this.reactiveForm = fb.group({
rut: ['30972198', [Validators.required, rutValidator]]
});
}
}
Template Form
<input [(ngModel)]="user.rut" name="rut" validateRut required>
RutPipe
{{ user.rut }}
<!-- 30972198 -->
{{ user.rut | rut }}
<!-- 3.097.219-8 -->
formatRut (Directive)
<input [(ngModel)]="user.rut" name="rut" formatRut required>
<!--
(on blur)
3.097.219-8
(on focus)
30972198
-->
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Credits
Thank you contributors!
ng2-rut is maintained by platanus.
License
Angular 2 RUT is © 2016 Platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.