Skip to content

odisleysi/ng16-rut

 
 

Repository files navigation

Angular 15 RUT

Angular 15 library with several components to handle Chilean RUT validation, cleaning and formatting.

Installation

yarn add ng15-rut
# or
npm install ng15-rut --save

Usage

Set-up:

The easiest way to use this library is to import Ng15Rut in your app's main module.

import { NgModule } from '@angular/core';
import { Ng15Rut } from 'ng15-rut';
import { BrowserModule } from '@angular/platform-browser';

@NgModule({
  ...
  imports: [
    BrowserModule,
    Ng15Rut
  ],
})
class DemoAppModule { }

See ./demo folder for a fully working example.

Using it:

ng15-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 the validateRut directive (to attach to models or inputs) and the RutValidator class to be used as Validator on reactive forms.
  • RutPipe: Exposes the RutPipe pipe to format rut numbers on templates
  • RutDirective: Exposes the formatRut 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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Credits

Thank you contributors!

Odisleysi

ng15-rut is maintained by odisleysi.

License

Angular 15 RUT is © 2023 GDExpress, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

About

Angular 15 library with several components to handle Chilean RUT validation, cleaning and formatting.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 66.0%
  • JavaScript 25.7%
  • HTML 8.3%