@ngx-formly

Status:

Links:

@ngx-formly is an Angular 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

Follow these steps to get started with ng-formly. Also check out our guides and demos for further examples.

1. Install @angular/forms and @ngx-formly/core packages:

  npm install @angular/forms @ngx-formly/core --save

2. Choose and install your UI (pre-defined types/templates) package:

• Material2:
  1. Ensure you have already installed material2 https://material.angular.io/guide/getting-started
  2. Install @ngx-formly/material

  npm install @ngx-formly/material --save

• Bootstrap:

  npm install @ngx-formly/bootstrap --save

3. Import the FormlyModule and UI (pre-defined types/templates):

import {NgModule} from '@angular/core';
import {ReactiveFormsModule} from '@angular/forms';
import {FormlyModule} from '@ngx-formly/core';
import {FormlyBootstrapModule} from '@ngx-formly/bootstrap';

// for material2 import `FormlyMaterialModule`:
// import {FormlyMaterialModule} from '@ngx-formly/material';

@NgModule({
  imports: [
    ...,
    ReactiveFormsModule,
    FormlyModule.forRoot(),
    FormlyBootstrapModule,

    // for material2 use:
    // FormlyMaterialModule
  ],
})
export class AppModule {}

3. Define the form config in your component:

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

@Component({
  selector: 'app',
  template: `
    <form [formGroup]="form" (ngSubmit)="submit(userModel)">
      <formly-form [model]="userModel" [fields]="userFields">
        <button type="submit" class="btn btn-default">Submit</button>
      </formly-form>
    </form>
  `,
})
export class AppComponent {
  form = new FormGroup({});
  userModel = { email: '[email protected]' };
  userFields: Array<FormlyFieldConfig> = [{
    key: 'email',
    type: 'input',
    templateOptions: {
      type: 'email',
      label: 'Email address',
      placeholder: 'Enter email',
      required: true,
    }
  }];

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

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

Roadmap

See the issues labeled enhancement

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!