Package detail

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Dynamic forms for angular with a GUI editor. Live demo: https://stackblitz.com/edit/formy

Built With

• Angular 8
• Bootstrap

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Add Formy package to your project.

npm install @konum/formy

Project installation

1. Clone the repo

   git clone https://github.com/github_username/repo.git
   npm install
   ng serve 

Usage

Import Formy module

import  {FormyModule} from '@konum/formy';

@NgModule({
  declarations: [....],
  imports: [....
    FormyModule
  ],
  providers: [.....]

})

Form Editor:

<lib-formy-editor [questions]="questions"  (onSave)="save($event)"></lib-formy-editor>

lib-formy-editor has to optiona inputs:

• questions: array of FormyInputBase objects
• questionsJson: string with array of FormyInputBase objects

onSave event will return and array of FormyInputBase object.

Form for filling:

<lib-formy [questions]="questions"  (onSave)="save($event)"></lib-formy>

lib-formy has to optiona inputs:

• questions: array of FormyInputBase objects
• questionsJson: string with array of FormyInputBase objects

onSave event will return and array of FormyInputBase object.

Roadmap

• Language support for editor

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Guillermo Gefaell - @twitter_handle - email

Project Link: https://github.com/konum/formy

Acknowledgements