wfw-ngx-formly
TypeScript icon, indicating that this package has built-in type declarations

4.2.0 • Public • Published
angular-formly logo

@ngx-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

Ngx Formly is a dynamic JSON powered form library for Angular (mainly based an on Angular Reactive Forms) that bring unmatched maintainability to your application's forms.

Supported UI libs

UI
Bootstrap
Ionic
Kendo
Material2
PrimeNG
NativeScript

Which Version to use?

Angular version Formly version
Angular >= 6 @ngx-formly/core@4.x
Angular >= 5 @ngx-formly/core@3.x
Angular >= 4 @ngx-formly/core@2.x
Angular >= 2 ng-formly@1.x

Quick links

Quick Start

Follow these steps to get started with Ngx Formly. Also check out our 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:

  npm install @ngx-formly/material --save
  • Bootstrap:

      npm install @ngx-formly/bootstrap --save
  • Ionic:

      npm install @ngx-formly/ionic --save
  • PrimeNG:

      npm install @ngx-formly/primeng --save
  • Kendo:

      npm install @ngx-formly/kendo --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';
 
// for ionic import `FormlyIonicModule`:
// import {FormlyIonicModule} from '@ngx-formly/ionic';
 
// for primeng import `FormlyPrimeNGModule`:
// import {FormlyPrimeNGModule} from '@ngx-formly/primeng';
 
// for kendo import `FormlyKendoModule`:
// import {FormlyKendoModule} from '@ngx-formly/kendo';
 
@NgModule({
  imports: [
    ...,
    ReactiveFormsModule,
    FormlyModule.forRoot(),
    FormlyBootstrapModule,
 
    // for material2:
    // FormlyMaterialModule
 
    // for ionic:
    // FormlyIonicModule
 
    // for primeng:
    // FormlyPrimeNGModule
 
    // for kendo:
    // FormlyKendoModule
  ],
})
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(model)">
      <formly-form [form]="form" [fields]="fields" [model]="model">
        <button type="submit" class="btn btn-default">Submit</button>
      </formly-form>
    </form>
  `,
})
export class AppComponent {
  form = new FormGroup({});
  model = { email: 'email@gmail.com' };
  fields: FormlyFieldConfig[] = [{
    key: 'email',
    type: 'input',
    templateOptions: {
      type: 'email',
      label: 'Email address',
      placeholder: 'Enter email',
      required: true,
    }
  }];
 
  submit(model) {
    console.log(model);
  }
}

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):

aitboudadmohammedzamakhandivyakumarjaincouzicfranzealbeeman

juristrdwaldrumKrustie101MarcosEllysthorgodAlexTalcura

Dayvissonjrgleasonn3xuskentcdoddsLennardWesterveldwaffle-iron

MathijsHooglandPoujaRironRonen-devblowsiesamtsai

Tom-Vdanielcrispfrancisco-sanchez-molinaTheMcMurder

Package Sidebar

Install

npm i wfw-ngx-formly

Weekly Downloads

0

Version

4.2.0

License

MIT

Unpacked Size

700 kB

Total Files

29

Last publish

Collaborators

  • gkr