MacKentoch / easyFormGenerator

create amazing forms without coding : form editor based on angular formly
http://mackentoch.github.io/easyFormGenerator/
MIT License
253 stars 116 forks source link
angularjs es6 webpack

Easy form generator (AngularJS)

npm GitHub version Join the chat at https://gitter.im/MacKentoch/easyFormGenerator Bower version npm version FOSSA Status

Generate advanced and unique boostrap forms without typing a single line of code!

— easy form generator website here —

What is it?

Easy form generator (step way or drag and drop way):

Complementary information to better understand easy form generator

Easy Form Generator: Step way

IMPORTANT: easyFormGenerator v2.1.1 introduced a breaking change to fix angular formly upgrade compatibility issue. This breaking change impacts Header control only. Header control field model now needs header value to be in templateOptions.placeholder (rather than in templateOptions.description). To help to ensure the right property is used by your previously saved fields model, description input is now added in Header edit modal (so just cut / paste description into header text input).

Step way version is the most accomplished and stable version.

Have a try here: Easy for generator step way version


Easy Form Generator: drag and drop way (BETA)

Drag and drop way version (currently in BETA) is more fun and faster to design a form

Drag and drop way is still in development.

Chrome will give you the best experience with drag and drop version. You may encounter unexpected behaviours with other navigators.

have a try here: Easy for generator drag and drop way version


Easy form viewer: production ready

Easy form viewer is a directive which helps you using your created forms


How to use?


Using Step way version (production friendly)

Check demo: stepway.html in preview directory

Install

Installing easyFormGenerator will install in a row:

Install:

npm install --save easy-form-generator

or

yarn install easy-form-generator

dependencies

Easy form generator creates amazing bootstrap forms thanks to these dependencies:

dependency npm install from dist/vendors
bootstrap (css / js) npm i --save bootstrap dist/vendors
bootswatch npm i --save bootswatch dist/vendors
jquery npm i --save jquery dist/vendors
angular js (>= 1.3.X) npm i --save angular dist/vendors
ngAnimate npm i --save angular-animate dist/vendors
angular-translate npm i --save angular-translate dist/vendors
angular-ui-bootstrap npm i --save angular-ui-bootstrap dist/vendors
textAngular npm i --save textangular dist/vendors
angular-strap npm i --save angular-strap dist/vendors
nya-bootstrap-select npm i --save @lordfriend/nya-bootstrap-select dist/vendors
angular toaster npm i --save angularjs-toaster dist/vendors

They are not include in easyFormGenerator bundle to avoid side effects / collisions in your application.

It is up to you to include them in your application depending on your dev workflow.

It will be far more talkative be checking demo:

Inject easy form generator in your app

Just inject eda.easyformGen.stepway in you application:

angular.module("YOUR_APP", [
  "eda.easyformGen.stepway" //injects easy form generator-step way
]);

All easy form generator just by this small html:

<eda-step-way-easy-form-gen></eda-step-way-easy-form-gen>

Want to Load/save models?

Add these attributes to interact with your own controller:

<eda-step-way-easy-form-gen
      eda-easy-form-generator-model="_MODEL_"
      eda-save-form-event="_SAVE_FUNCTION_">
</eda-step-way-easy-form-gen>

eda-easy-form-generator-model properties are:

field name field format field description
formName string stores form name, default is empty string
btnSubmitText string stores submit button name, default is 'Submit'
btnCancelText string stores submit button name, default is 'Cancel'
edaFieldsModel array easy form generator fields model that describe form
edaFieldsModelStringified string edaFieldsModel but stringified (then easy to save fields model to any database)
formlyFieldsModel object angular formly fields model (filled by easy form generator from edaFieldsModel)
dataModel object filling the form feeds dataModel

eda-save-form-event function:

//your controller save function should have `edaEasyFormGeneratorModel` parameter
//it will be filled by easy form generator model
saveForm(edaEasyFormGeneratorModel);

Customize easyFormGenerator

Multilanguage support:

Default or fallback language is set to english by default (but you can change this fallback language).

language key note
english 'en'
french 'fr'
german 'de'
japanese 'jp'
spanish 'es' thx to Benjamin Orozco :thumbsup:
turkish 'tr' thx to Serhat Can :thumbsup:
bresilian portuguese 'pt-br' thx to Leandro.Battisti :thumbsup:
chinese 'zh' thx to @alansong :thumbsup:

preview

Change the default language in your controller:

angular
.module('YOURAPP', ['...'])
.config(easyFromConfigFct);

//inject easyFormSteWayConfigProvider
easyFromConfigFct.$inject = ['easyFormSteWayConfigProvider'];
function easyFromConfigFct(easyFormSteWayConfigProvider){

//example get current language (by default = english)
console.info(easyFormSteWayConfigProvider.getCurrentLanguage());
//set language to french (see corresponding keys in upper table):
easyFormSteWayConfigProvider.setLanguage('fr');

enable disable controls:

All controls are enabled by default.

control name control key
empty control empty
header header
Subtitle Subtitle
TextInput TextInput
Password Password
Email Email
IpAdress IpAdress
Date Date
Texarea Texarea
RichTextEditor RichTextEditor
Radio Radio
Checkbox Checkbox
BasicSelect BasicSelect
GroupedSelect GroupedSelect
 angular
   .module('YOURAPP', ['...'])
   .config(easyFromConfigFct);

 //inject easyFormSteWayConfigProvider
 easyFromConfigFct.$inject = ['easyFormSteWayConfigProvider'];
 function easyFromConfigFct(easyFormSteWayConfigProvider){
   /////////////////////////////
   // DISABLE EXAMPLES
   /////////////////////////////
   //disable a single control:
   easyFormSteWayConfigProvider.disableControl('TextInput');
   //disable a list of controls:
   easyFormSteWayConfigProvider.disableControl(['BasicSelect', 'GroupedSelect']);

   /////////////////////////////
   // ENABLE EXAMPLES
   /////////////////////////////
   //enable a single control:
   easyFormSteWayConfigProvider.enableControl('TextInput');
   //enable a list of controls:
   easyFormSteWayConfigProvider.enableControl(['BasicSelect', 'GroupedSelect']);

show hide preview panel details:

angular
  .module("appDemo", [
    "eda.easyformGen.stepway" //injects easy form generator-step way
  ])
  .config(configFct)
  .controller("demoController", demoController);

/**
 * config
 */
configFct.$inject = ["easyFormSteWayConfigProvider"];
function configFct(easyFormSteWayConfigProvider) {
  //show/hide preview panel => default is true
  easyFormSteWayConfigProvider.showPreviewPanel(true);
  //show/hide models in preview panel => default is true
  easyFormSteWayConfigProvider.showPreviewModels(true);
}

Using Drag and drop way version (BETA)

Check demo: dragDropWay.html in preview directory

Install

Installing easyFormGenerator will install in a row:

Install:

npm install --save easy-form-generator

or

yarn install easy-form-generator

dependencies

Easy form generator creates amazing bootstrap forms thanks to these dependencies:

dependency npm install from dist/vendors
bootstrap (css / js) npm i --save bootstrap dist/vendors
bootswatch npm i --save bootswatch dist/vendors
jquery npm i --save jquery dist/vendors
angular js (>= 1.3.X) npm i --save angular dist/vendors
ngAnimate npm i --save angular-animate dist/vendors
angular-translate npm i --save angular-translate dist/vendors
angular-ui-bootstrap npm i --save angular-ui-bootstrap dist/vendors
textAngular npm i --save textangular dist/vendors
angular-strap npm i --save angular-strap dist/vendors
nya-bootstrap-select npm i --save @lordfriend/nya-bootstrap-select dist/vendors
angular toaster npm i --save angularjs-toaster dist/vendors

They are not include in easyFormGenerator bundle to avoid side effects / collisions in your application.

It is up to you to include them in your application depending on your dev workflow.

It will be far more talkative be checking demo: dragDropWay.html in preview directory

Inject easy form generator in your app

Just inject eda.easyformGen.dragdropway in you application:

angular.module("appDemo", [
  "eda.easyformGen.dragdropway" //injects easy form generator drag and drop way
]);

All easy form generator just by this small html:

<eda-dragdrop-way-easy-form-gen></eda-dragdrop-way-easy-form-gen>

Want to Load/save models?

Add these attributes to interact with your own controller:

<eda-dragdrop-way-easy-form-gen
      eda-easy-form-generator-model="_MODEL_"
      eda-save-form-event="_SAVE_FUNCTION_">
</eda-dragdrop-way-easy-form-gen>

eda-easy-form-generator-model properties are:

field name field format field description
formName string stores form name, default is empty string
btnSubmitText string stores submit button name, default is 'Submit'
btnCancelText string stores submit button name, default is 'Cancel'
edaFieldsModel array easy form generator fields model that describe form
edaFieldsModelStringified string edaFieldsModel but stringified (then easy to save fields model to any database)
formlyFieldsModel object angular formly fields model (filled by easy form generator from edaFieldsModel)
dataModel object filling the form feeds dataModel

eda-save-form-event function:

//your controller save function should have `edaEasyFormGeneratorModel` parameter
//it will be filled by easy form generator model
saveForm(edaEasyFormGeneratorModel);

Using Easy form viewer (production friendly)

demo: formviewer.html in preview directory

Install

Installing easyFormGenerator will install in a row:

Install:

npm install --save easy-form-generator

or

yarn install easy-form-generator

dependencies

Easy form generator creates amazing bootstrap forms thanks to these dependencies:

dependency npm install from dist/vendors
bootstrap (css / js) npm i --save bootstrap dist/vendors
bootswatch npm i --save bootswatch dist/vendors
jquery npm i --save jquery dist/vendors
angular js (>= 1.3.X) npm i --save angular dist/vendors
ngAnimate npm i --save angular-animate dist/vendors
textAngular npm i --save textangular dist/vendors
nya-bootstrap-select npm i --save @lordfriend/nya-bootstrap-select dist/vendors

They are not include in easyFormGenerator bundle to avoid side effects / collisions in your application.

It is up to you to include them in your application depending on your dev workflow.

It will be far more talkative be checking demo: formviewer.html in preview directory

Inject easy form viewer in your app

Just inject eda.easyFormViewer in you application:

(function(angular){
    'use strict';
    angular
        .module('app', ['eda.easyFormViewer']) //inject easy form viewer
        .controller('demoController', demoController);

    //your controller, here an implementation suggestion
    demoController.$inject = ['$timeout'];
    function demoController($timeout){
      var demoCtrl = this;

      demoCtrl.fieldsModel    = loadMySavedEdaFieldsModel(); //="edaFieldsModel" - see easy form generator model -
      demoCtrl.dataModel            = {}; //data Model: filling form will fill it (submit event will return updated data model)

      demoCtrl.submitButtonText = 'Submit this form'; //button text
      demoCtrl.cancelButtonText = 'Cancel all'; //button text

      demoCtrl.submitFormEvent  = submitFormEvent; //event called on form submit
      demoCtrl.cancelFormEvent  = cancelFormEvent; //event called on form cancel

      function loadMySavedEdaFieldsModel(){
        var mySavedModel = readItWhereISavedIt();
        return mySavedModel;
      }

      //submit will return updated dataModel in "dataModelSubmitted" parameter
      function submitFormEvent(dataModelSubmitted){
        console.info('Submit event: you can manage this event in your controller');
        console.dir( {'dataModelSubmitted': dataModelSubmitted} );
      }

      function cancelFormEvent(){
        console.info('Cancel event: you can manage this event in your controller');
      }
    }
      //...

All easy form viewer directive:

<eda-easy-form-viewer
        eda-easy-form-viewer-data-model="demoCtrl.dataModel"
        eda-easy-form-viewer-easy-form-generator-fields-model="demoCtrl.fieldsModel"

        eda-easy-form-viewer-submit-button-text="{{demoCtrl.submitButtonText}}"
        eda-easy-form-viewer-cancel-button-text="{{demoCtrl.cancelButtonText}}"

        eda-easy-form-viewer-submit-form-event="demoCtrl.submitFormEvent(dataModelSubmitted)"
        eda-easy-form-viewer-cancel-form-event="demoCtrl.cancelFormEvent()">
</eda-easy-form-viewer>
eda-easy-form-viewer property format description
eda-easy-form-viewer-data-model object data model to preload form (from a previous database save for example).
eda-easy-form-viewer-easy-form-generator-fields-model object easy form generator generated form object (by step way or drag and drop way)
eda-easy-form-viewer-submit-button-text string submit button text
eda-easy-form-viewer-cancel-button-text string cancel button text
eda-easy-form-viewer-submit-form-event function to handle submit event in your controller (like saving data model for example)
eda-easy-form-viewer-cancel-form-event function to handle cancel event in your controller

What is new?

older:

angular
  .module("appDemo", [
    "eda.easyformGen.stepway" //injects easy form generator-step way
  ])
  .config(configFct)
  .controller("demoController", demoController);

/**
 * config
 */
configFct.$inject = ["easyFormSteWayConfigProvider"];
function configFct(easyFormSteWayConfigProvider) {
  //show/hide preview panel => default is true
  easyFormSteWayConfigProvider.showPreviewPanel(true);
  //show/hide models in preview panel => default is true
  easyFormSteWayConfigProvider.showPreviewModels(true);
}
 angular
   .module('YOURAPP', ['...'])
   .config(easyFromConfigFct);

 //inject easyFormSteWayConfigProvider
 easyFromConfigFct.$inject = ['easyFormSteWayConfigProvider'];
 function easyFromConfigFct(easyFormSteWayConfigProvider){

   //example get current language (by default = english)
   console.info(easyFormSteWayConfigProvider.getCurrentLanguage());
   //set language to french:
   easyFormSteWayConfigProvider.setLanguage('fr');
 angular
   .module('YOURAPP', ['...'])
   .config(easyFromConfigFct);

 //inject easyFormSteWayConfigProvider
 easyFromConfigFct.$inject = ['easyFormSteWayConfigProvider'];
 function easyFromConfigFct(easyFormSteWayConfigProvider){

   //disable basic TextInput:
   easyFormSteWayConfigProvider.disableControl('TextInput');

   //enable Date input:
   //(NOTE: by default all controls are enabled
   //-> so this example is no other use than illustration)
   easyFormSteWayConfigProvider.enableControl('Date');

   // List of all easy form generator (step way version) controls:
   // 'empty'
   // 'Header'
   // 'TextInput'
   // 'Password'
   // 'Date'
   // 'Texarea'
   // 'RichTextEditor'
   // 'Radio'
   // 'Checkbox'
   // 'BasicSelect'
   // 'GroupedSelect'
angular.module("YOUR_APP", []).config(easyFromConfigFct);

easyFromConfigFct.$inject = ["easyFormSteWayConfigProvider"];
function easyFromConfigFct(easyFormSteWayConfigProvider) {
  //enable/disable easy form modal animation
  //HERE: animation disabled due to angular bootstrap backdrop bug with angular >= 1.4
  easyFormSteWayConfigProvider.setModalAnimation(false);
}
+ more easy form generator - step way - config. later

email and validations

Donate

Do you use & like easyFormGenerator but you don’t find a way to show some love? If yes, please consider donating to support this project. Otherwise, no worries, regardless of whether there is support or not, I will keep maintaining this project. Still, if you buy me a cup of coffee I would be more than happy though 😄

Support via PayPal

License

The MIT License (MIT)

Copyright (c) 2019 Erwan DATIN

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FOSSA Status