Drag and drop dynamic bootstrap forms with angular.
An extendable angular module that allows you and/or your web users to design and render bootstrap forms. Field components can be dragged from a pallette onto a canvas where details like validation can be fine-tuned further. Developers can extend the editor by adding custom field components and validation patterns.
A full blown demonstration is available on angular-form-gen.nullest.com. Smaller examples can be found on plunker:
This module was build using AngularJS ~1.3.8 and Bootstrap (CSS) ~3.2.0. Requires Angular v.1.3. With version 1.2 will fail due changes in $interpolate and ng-pattern.
Install the package with bower:
$ bower --save install angular-form-gen
Include both angular-form-gen.css and angular-form-gen.js in your index.html.
Setup your main module dependencies:
angular.module('myApp', ['fg']);
FormGen can be split in two areas:
- The schema editor
- The form renderer
The schema editor is where the structure and behaviour of the form is created. FormGen comes with a client-side editor, which allows you to drag and drop fields to a canvas and modify properties like labels, model-names and/or validation rules. The complete set of fields and their associated behaviour is bundled in a schema object. Since this is a simple javascript object it can be stored easily on a backend database.
To display the form to a user the so called renderer is used. This simply takes an earlier created schema object, transforms it into a bootstrap form and validates the input of the user.
The schema editor can be embedded in any form by marking a child element with a fg-edit attribute and providing the target schema model with the fg-schema directive.
<!-- Create normal bootstrap form element -->
<form class="form-horizontal">
<!-- Embed the schema editor on the form -->
<div fg-edit fg-schema="myForm.schema"></div>
</form>
The editor behaves just like any other angular form element; if the schema model is invalid the parent form status is set to $invalid, if anything in the schema has been modified the form status is set to $dirty.
The schema editor is split in two main columns. On the left side is the canvas, which contains all the fields that are a member of the current schema. On the right side is the palette, which contains all the available field templates. The contents of the palette is determined by the selected category.
Fields can be added to the schema by either pressing the add button on the field in the palette or by dragging and dropping the field from the palette on the canvas. The order of fields can be modified by using the up and down buttons or by dragging and dropping the field to the desired position. A field can be removed by pressing the delete button.
By pressing on the configure button the configuration panes become visible for the specific field. The configuration options are separated in several tabs. Some of them are only specific for certain field types.
These are the most common field properties.
Depending on the field type the following properties are available.
- Name: The name of the field
- Display name: The name to show on the label
- Placeholder text: The text to use as placeholder
- Tooltip: The text to use as tooltip
- Initial value: The initial value of the field
Here the validation rules can be applied to the field. For each validation rule that is enabled, a custom message can be supplied to be shown to the user if the field value doesn't validate. This is complete optional -- if no message is specified, a default for that specific validation type is used.
Depending on the field type the following properties are available.
- Minimum length: Field value must be at least this length
- Maximum length: Field value must not exceed this length
- Pattern: Field value should match this pattern
- Required: Field value is required
This tab is only available for field types that have a list of options, such as the select element. Form designers can add and/or remove items here from the option list.
The debug tab shows the schema properties for the current field.
Like the schema editor, the form renderer should be a child element of a form element. This allows for more customisation, like rendering multiple schemas and/or adding form fields without the need for a pre-generated schema.
Rendering of a schema is done by the fg-form directive:
<form novalidate class="form">
<div fg-form
fg-form-data="myFormData"
fg-schema="mySchema">
</div>
</form>
The fg-form-data attribute specifies that target object model. This model will receive all the input values of the fields. If for example the schema contains a field with the name myField, the value of the input will be stored at myFormData.myField.
Any parent form or ng-form state will be updated accordantly if any of the validation rules defined in the schema will fail or succeed.
<form novalidate class="form" name="myForm">
<div fg-form
fg-form-data="myFormData"
fg-schema="mySchema">
</div>
<!-- set the disabled class on the submit button when the form state is invalid -->
<button type="submit"
class="btn btn-primary"
ng-class="{ disabled: myForm.$invalid }">
Submit
</button>
</form>
The form renderer works with both the form and the form-horizontal bootstrap classes.
# Clone the github project
$ git clone [email protected]:McNull/angular-form-gen.git
$ cd angular-form-gen
# Install dependencies
$ npm install
$ bower install
# Build the demonstration website (outputs into ./dest)
$ gulp build
# Build a distribution release (outputs into ./dist)
$ gulp dist
# Start watch/autobuild
$ gulp-tasks/watch.sh
# Execute tests
$ karma start