It's so easy to create custom templates that this library does not provide much value and by using it you'll wind up having to do a bunch of work arounds. It is recommended that you just create your own templates. If you disagree, feel free to let me know in the issues and I can giv eyou ownership of the repo.
This is a template for Angular-Formly which adds template basic files with no css classes. Each field is wrapped in a div. This library is not standalone and requires angular-formly to be present and loaded.
There were some significant changes that you'll want to be aware of. In order to upgrade and get all the cool features, you're going to need to change your field configurations. Here is a tool that should help make that process easier. Also, if you are not able to update the configuration very easily, see this issue for ideas on how to ease things a little.
-
Required to use Formly:
-
Angular
-
Angular-Formly
-
Dev dependencies to build Formly
-
npm
-
Install Angular-Formly
-
Install Angular-Formly: Bootstrap Templates
$ bower install angular-formly angular-formly-templates-vanilla --save
or
$ npm install angular-formly angular-formly-templates-vanilla --save
- Include the javascript file in your index.html, Formly comes in the following flavors:
<script src="bower_components/angular-formly/dist/formly.min.js"></script>
<script src="bower_components/angular-formly-templates-vanilla/dist/angular-formly-templates-vanilla.min.js"></script>
and
angular.module('yourModule', ['formly', 'formlyVanilla']);
or
angular.module('yourModule', [require('angular-formly'), require('angular-formly-templates-vanilla')]);
See Angular-Formly for formly core documentation.
NOTE: All of these properties will be under the templateOptions
property as of angular-formly 3.0.0
label
is used to add an html label to each field.
A default is set for each field based on its type. ie
Text
,Checkbox
,Password
required
is used to add the required attribute to a form field.
undefined
hide
is used to conditionally show the input. When true, the input is hidden (meant to be used with a watch).
undefined
disabled
is used to add the disabled attribute to a form field.
undefined
placeholder
is used to add placeholder text to some inputs.
undefined
description
is used to add descriptive text to all inputs.
undefined
Below is a detailed description of each form fields and its custom properties.
The input uses the element and allows you to specify it's type via the type property
Example text field
{
"type": "text",
"key": "firstName",
"templateOptions": {
"type": "email", // or url, or text, etc.
"placeholder": "jane doe",
"label": "First name"
}
}
The textarea field creates multiline input with a textarea element.
lines
sets the rows attribute for the textarea element.
Example textarea field
{
"type": "textarea",
"key": "about",
"templateOptions": {
"placeholder": "I like puppies",
"label": "Tell me about yourself",
"rows": 4,
"cols": 15
}
}
The checkbox field allows checkbox input with a input element set to
type='checkbox'
. It doesn't have any custom properties.
Example checkbox field
{
"type": "checkbox",
"key": "checkThis",
"templateUrl": {
"label": "Check this box"
}
}
The radio field allows multiple choice input with a series of linked inputs, with
type='radio'
.
options
is an array of options for the radio form field to display. Each option should be an object with aname
(string) andvalue
(string or number).
Example radio field
{
"key": "triedEmber",
"type": "radio",
"templateOptions": {
"label": "Have you tried EmberJs yet?",
"options": [
{
"name": "Yes, and I love it!",
"value": "yesyes"
},
{
"name": "Yes, but I'm not a fan...",
"value": "yesno"
},
{
"name": "Nope",
"value": "no"
}
]
}
}
The select field allows selection via dropdown using the select element.
The default can be set to the index of one of the
options
.
options
is an array of options for the select form field to display. Each option should be an object with aname
(string). You may optionally add agroup
to some or all of your options.
Example select field
{
"key": "transportation",
"type": "select",
"templateOptions": {
"label": "How do you get around in the city",
"options": [
{
"name": "Car"
},
{
"name": "Helicopter"
},
{
"name": "Sport Utility Vehicle"
},
{
"name": "Bicycle",
"group": "low emissions"
},
{
"name": "Skateboard",
"group": "low emissions"
},
{
"name": "Walk",
"group": "low emissions"
},
{
"name": "Bus",
"group": "low emissions"
},
{
"name": "Scooter",
"group": "low emissions"
},
{
"name": "Train",
"group": "low emissions"
},
{
"name": "Hot Air Baloon",
"group": "low emissions"
}
]
}
}
Please see the CONTRIBUTING Guidelines.
A special thanks to Nimbly for creating/sponsoring Angular-Formly's development. Thanks to Kent C. Dodds for his continued support on the project.