Giter Club home page Giter Club logo

dorf's Introduction

npm version Build Status

Domain Object Reactive Forms

Version 4 for Angular 5+.

I'm maintaining this library in my free time. But since my son was born in 2017, I have little to no free time :)

Model-driven forms within the model!

example

Angular's Reactive Forms (a.k.a. Model-driven Forms) are great. Then, the dynamic generation of such forms is the next evolution step (sometimes called Dynamic Forms). This library is about taking those things to yet another level by coupling forms with Domain Objects.

Want to create a form for an object?

  1. Add some annotations to the object.

    @DorfObject()
    export class Person {
        @DorfInput({
            label: "Name", 
            type: "text",
            validator: Validators.required, 
            errorMessage: "Name is required",
            updateModelOnChange: true
        })
        name: string;
    
        @DorfInput({
            label: "Surname", 
            type: "text",
            validator: Validators.required, 
            errorMessage: "Surname is required",
            updateModelOnChange: true
        })
        surname: string;
    }
  2. Create a Component form which implements IDorfForm and uses some annotations. E.g. you should pass the above object as an annotated (@DorfObjectInput()) property.

    @DorfForm() // must be above the Component annotation!
    @Component({
        selector: "person-details"
        // no template or templateUrl = default one from DORF (!)
    })
    export class PersonDetailComponent implements IDorfForm {
        @DorfObjectInput() domainObject: Person; // has Angular's @Input() behavior as well (!)
    
        constructor(public config: DorfConfigService) { }
    
        onDorfSubmit() {
            let result = this["form"].value;
            console.log(result);
        }
    }
  3. You are done! Really! Enjoy your Reactive Form.

Detailed tutorials

Documentation

Generated API documentation

Vision

The aim of this library is to speed up boring things like a creation of the ordinary forms and styling them. Library is not strictly connected with any CSS framework. You can just pass the classes as DorfConfigService parameters.

Future plans include:

  • More tests, a nice documentation and step by step tutorial on building with DORF
  • UX improvements - aria support, styles prepared for most common libraries
  • Reactive grids. It is another boring, ordinary thing (and onSummary is already presented in the field definition)
  • Angular Material module
  • Form arrays
  • Methods for speeding up the creation of custom fields (even more)

List of the online examples

dorf's People

Contributors

mat3e avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

dorf's Issues

It is not working for angular 5 it

Just say template is not defined I have to specify a template in the component in which I use @DorfForm()

I debugged it and var annotations = window.Reflect.getMetadata('annotations', targetConstructor); on forf-form.decorator.ts returns undefined. I was reading on internet and this came up

Angular team has changed logic for metadata created by invoking the decorators.
It is no longer dependent on Reflect API.
You can try AppModule['annotations']

for the case

var annotations = targetConstructor['annotations'];
if (annotations && annotations.length) {
var components = annotations.filter(function (annotation) {
return annotation.proto && annotation.proto.ngMetadataName === 'Component';
});

Configuration by annotations

@DorfDomainObject as a class-level decorator and related @DorfInputDefinition, @DorfSelectDefinition property-level decorators for defining Domain Object's properties for the form.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.