Generate forms from JSON schemas using AngularJS!

Try out the example page. Try editing the schema or form definition and see what comes out!

Schema Form is a set of AngularJS directives (and a couple of services). It can do two things to make life easier:

1. Create a form directly from a JSON schema.
2. Validate form fields against that same JSON schema.

Schema Form uses convention over configuration, so it comes packaged with some sensible defaults. But you can always customize it by changing the order and types of form fields.

Schema Form is inspired by the nice JSON Form library and aims to be roughly compatible with it, especially its form definition. So what sets Schema Form apart from JSON Form?

1. Schema Form integrates deeply with AngularJS and uses AngularJS conventions to handle forms.
2. Schema Form uses tv4 for validation, making it compatible with version 4 of the JSON schema standard.
3. By default, Schema Form generates Bootstrap 3-friendly HTML.

Documentation covering defaults and form types can be found here. And you can find the documentation for how you extend angular schema form with your own types here.

First, expose your schema, form, and model to the $scope.

angular.module('myModule', ['schemaForm'])
       .controller('FormController', function($scope) {
  $scope.schema = {
    type: "object",
    properties: {
      name: { type: "string", minLength: 2, title: "Name", description: "Name or alias" },
      title: {
        type: "string",
        enum: ['dr','jr','sir','mrs','mr','NaN','dj']
      }
    }
  };

  $scope.form = [
    "*",
    {
      type: "submit",
      title: "Save"
    }
  ];

  $scope.model = {};
});

Then load them into Schema Form using the sfSchema, sfForm, and sfModel directives.

<div ng-controller="FormController">
    <form sf-schema="schema" sf-form="form" sf-model="model"></form>
</div>

It's simplest to install Schema Form using Bower.

bower install angular-schema-form

This will install the latest release and basic dependencies. See dependecies section below.

You can also just download the contents of the dist/ folder and add dependencies manually.

Schema form has a lot of dependencies, most of which are optional. Schema Form depends on:

1. AngularJS version 1.3.x is recomended. Version 1.2.x has some limitation. See known limitations.
2. angular-sanitize
3. tv4
4. objectpath
5. bootstrap 3

If you install via bower you get all of the above except bootstrap since we don't want to push a certain version or flavor on you. Also make sure you got the angular version you actually want.

1. If you'd like to use drag-and-drop reordering of arrays, you'll also need ui-sortable and its jQueryUI dependencies. See the ui-sortable documentation for details about which parts of jQueryUI are needed. You can safely ignore these if you don't need reordering.
2. Schema Form provides tabbed arrays through the form type tabarray. Tab arrays default to tabs on the left side. For these to work, you'll need to include the CSS from bootstrap-vertical-tabs. However, you won't need Bootstrap Vertical Tabs for horizontal tabs (the tabType: "top" option).

The minified files include templates - no need to load additional HTML files.

Schema form is split into two main files, dist/schema-form.min.js and dist/boostrap-decorator.min.js and they need be loaded in that order. AngularJ, tv4 and objectpath also needs to be loaded before Schema Form.

<script type="text/javascript" src="bower_components/angular/angular.min.js"></script>
<script type="text/javascript" src="bower_components/angular-sanitize/angular-sanitize.min.js"></script>
<script type="text/javascript" src="bower_components/tv4/tv4.js"></script>
<script type="text/javascript" src="bower_components/objectpath/lib/ObjectPath.js"></script>
<script type="text/javascript" src="bower_components/angular-schema-form/dist/schema-form.min.js"></script>
<script type="text/javascript" src="bower_components/angular-schema-form/dist/bootstrap-decorator.min.js"></script>

Don't forget to load the schemaForm module or nothing will happen.

angular.module('myModule', ['schemaForm']);

There is currently three add-ons, a date picker, a colorpicker and the wysiwyg html editor tinymce. They have their own repos and you can find them here with usage instructions:

• https://github.com/Textalk/angular-schema-form-datepicker
• https://github.com/Textalk/angular-schema-form-colorpicker
• https://github.com/Textalk/angular-schema-form-tinymce

Your can also create your own add-ons!

All contributions are welcome! If its a new field type consider making it an add-on instead, especially if it has dependecies. See extending Schema Form documentation.

We're trying to use git flow, so please base any merge request on the development branch instead of master.

Also run any code through the code style checker jscs (or even better use it in your editor) with preset set to google. You can also us gulp jscs to check your code.

The files in the dist/ folder, plus dependencies, are all you need to use Schema Form. But if you'd like to build it yourself, we use gulp.

First off, you need to have nodejs installed. Then install all dev dependencies of the project with npm, install gulp and run the default task.

$ npm install
$ sudo npm install -g gulp
$ bower install
$ gulp

The default task uses gulp-angular-templatecache to compile all html templates to js and then concatenates and minifies them with the rest of the sources.

You can also run gulp watch to have it rebuild on change.

Unit tests are run with karma and written using mocha, chai and sinon

To run the tests:

1. Install all dependencies via NPM
2. Install dev dependencies with bower.
3. Install the Karma CLI
4. Run the tests

$ npm install
$ bower install
$ sudo npm install -g karma-cli
$ karma start karma.conf.js