@nbfontana/ngx-br

Brazilian components module for Angular

Stats

StarsIssuesVersionUpdatedCreatedSize
@nbfontana/ngx-br
4831.0.0-rc.4.0.2a year ago4 years agoMinified + gzip package size for @nbfontana/ngx-br in KB

Readme

@nbfontana/ngx-br

I'm the brazilian module for angular

Build Status npm version codecov

There're many repositories covering Brazilian needs for software development. NgxBr is here to concentrate almost everything that you need to build a functional pt-br software with Angular. We give you a full set of components (inputs, select, etc) covering fields like CEP, CPF, CNPJ, ESTADOS, etc. Beside that, we make available everything we use to build our components for the user, like Pipes and Directives (masks).

Feel free to use the entire NgxBrModule if it's your need, but you can always import components or pipes separatedly. Use it the way you want to.

Contents

Usage

Install as a dependency:

$ npm install --save @nbfontana/ngx-br

Then, you need to include NgxBrModule in your app:

import { Component, NgModule } from '@angular/core';
import { NgxBrModule } from '@nbfontana/ngx-br';

@NgModule({
  imports: [
    NgxBrModule.forRoot()
  ]
})
export class MyModule {}

And use it:

import { Component } from '@angular/core';

@Component({
  template: '<cpf formControlName="cpf" [(ngModel)]="model.cpf"></cpf>'
})
export class MyComponent {}

FAQ

How do the inputs look like? bootstrap, material?

NgxBr is using Bootstrap classes for now, so, if you override the bootstrap style for .form-control, it'll be applied to all inputs as well. But we'll work to let it more flexible, all ideas are welcome! Open an Issue (you can write it in Portuguese).

Help needed

Maybe you could help me define the way that components may be stylized?

Wich components should be added?

What kind of utilities may also be added and helpfull to be used within and outside ngx-br?

MIT @ Neri Bez Fontana

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.