ng-formly

ng-formly is an Angular 2 module which has a Components to help customize and render JavaScript/JSON configured forms. The formly-form Component and the FormlyConfig service are very powerful and bring unmatched maintainability to your application's forms

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ng-formly
2,6981442.0.06 years ago7 years agoMinified + gzip package size for ng-formly in KB

Readme

angular-formly logo
ng-formly
Angular Style Guide All Contributors Stories in Ready
Status: Build Status npm version devDependencies Status Package Quality Known Vulnerabilities codecov.io
Links: Gitter PRs Welcome
angular2-formly is an Angular 2 module which has a Components to help customize and render JavaScript/JSON configured forms. The formly-form Component and the FormlyConfig service are very powerful and bring unmatched maintainability to your application's forms.

Quick Start

  1. Install ng-formly

npm install ng-formly --save

  1. Import the FormlyModule:

import {NgModule} from '@angular/core';
import {FormsModule, ReactiveFormsModule} from '@angular/forms';
import {BrowserModule} from '@angular/platform-browser';
import {FormlyModule, FormlyBootstrapModule} from 'ng-formly';
import {AppComponent} from './app';

@NgModule({
  imports: [
    BrowserModule,
    FormsModule,
    ReactiveFormsModule,
    FormlyModule.forRoot(),
    FormlyBootstrapModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent]
})
export class AppModule {
}

  1. Define the form config in your component:

import {Component} from '@angular/core';
import {Validators, FormGroup} from '@angular/forms';
import {FormlyFieldConfig} from 'ng-formly';

@Component({
  selector: 'app',
  template: `
    <form class="formly" role="form" novalidate [formGroup]="form" (ngSubmit)="submit(user)">
        <formly-form [model]="user" [fields]="userFields">
            <button type="submit" class="btn btn-default">Button</button>
        </formly-form>
    </form>
  `,
})
export class HelloApp {
  form: FormGroup = new FormGroup({});
  userFields: Array<FormlyFieldConfig> = [{
    className: 'row',
    fieldGroup: [{
        className: 'col-xs-6',
        key: 'email',
        type: 'input',
        templateOptions: {
            type: 'email',
            label: 'Email address',
            placeholder: 'Enter email'
        },
        validators: {
          validation: Validators.compose([Validators.required])
        }
    }, {
        className: 'col-xs-6',
        key: 'password',
        type: 'input',
        templateOptions: {
            type: 'password',
            label: 'Password',
            placeholder: 'Password',
            pattern: ''
        },
        validators: {
          validation: Validators.compose([Validators.required])
        }
    }]
  }];

  user = {
    email: 'email@gmail.com',
    checked: false
  };

  submit(user) {
    console.log(user);
  }
}

From there, it's just JavaScript. Allowing for DRY, maintainable, reusable forms.

Roadmap

See the issues labeled enhancement

Supported templates

- Material2
- Bootstrap
```ts
  import {FormlyBootstrapModule} from 'ng-formly';
```

Thanks

A special thanks to Kent C. Dodds for giving me opportunity to work on this. This library is maintained (with love) by me, Mohammed Zama Khan. Thanks to all contributors! If you're trying to find angular-formly, go here

Contributors

Thanks goes to these wonderful people (emoji key):
|
Zama Khan Mohammed

📖 💻 👀 💁 🚇 🔧 |
Abdellatif Ait boudad

💻 📖 ⚠️ 👀 💁 |
divyakumarjain

💻 📖 🔌 👀 💁 |
Pouja

💻 👀 |
Caleb Kniffen

🐛 |
Riron

🐛 |
Thiago Lacerda

🐛 | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | |
danielcrisp

🐛 💻 |
Tony Franzese

🐛 💻 |
Jackie Gleason

🐛 💻 |
ampsarfraz

🐛 |
Krustie101

🐛 💻 |
ultimafirez

🐛 |
This project follows the all-contributors specification. Contributions of any kind welcome!