Skip to content

dgieselaar/vorm

Repository files navigation

Tests passing

vorm

Generate dynamic, stateful Angular forms via JSON, JavaScript Objects or HTML and still talk to the same API. Vorm is largely based on my experiences with writing another Angular form generator. It (kind of) favors immutability & functional programming over shared mutable state and parsed expressions. It's backed by over 80 tests, with close to 100% code coverage.

What does vorm do?

Vorm is an Angular module for generating (via JSON/HTML) and decorating (HTML) forms and form controls. No matter how you write your forms, the same API is available.

Features

Generate form controls with JSON & JavaScript objects

Simply pass an array of configuration objects (of which only name and type are required) to vorm and it'll take care of the rest. Supported by default: text, number, textarea, select, radio, checkbox, date, and more.

Dynamic form state

You can easily adjust form state via so-called invokables, which can be a primitive, an object, a function or an array/injectable. Hide and show fields, change a label or the options of a select box, or set the required state, based on form values or any other part of your application state.

Every field supports any number of controls

The default number of controls for any field is 1, but you can allow the user to add any number of controls via the configuration object. This is very useful when you want to support more than one value. Think, for example, of a field which allows the user to fill in one or more IP addresses.

Theming

With the vormTemplateServiceProvider you can either customize or override the wrapper, control list, and model templates.

Adding your own controls

vorm supports any control which is based on ngModel out of the box. No extra work is required (or even possible).

Fine-grained control

You have access to all the building blocks, which means you can write your forms any which way you please. Via JSON, JavaScript Objects but also via HTML (including wrapping existing form controls via vorm-field-wrapper).

How do I get started?

vorm is available on both npm and bower as vormjs.

npm: $ npm install vormjs

bower: $ bower install vormjs

For now, read the source code, ping me on Twitter, or check out the examples:

Woefully incomplete documentation

About

Write your forms in JSON and HTML, use the same API

Resources

License

Stars

Watchers

Forks

Packages

No packages published