Skip to content
This repository was archived by the owner on Apr 30, 2018. It is now read-only.

Commit 030f1ab

Browse files
committed
added linking and placeholder titles
1 parent 4bbac6b commit 030f1ab

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

README.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -84,59 +84,67 @@ Example data as it would be set in the controller
8484
When constructing fields use the options below to customize each field object. You must set at least a `type` or `templateUrl`.
8585

8686
##### type (string)
87-
`type` is the type of field to be rendered. Either type or templateUrl must be set.
87+
>`type` is the type of field to be rendered. Either type or templateUrl must be set.
8888
8989
###### Default
90-
`null`
90+
>`null`
9191
9292
###### Values
93-
[`text`](#text-form-field), [`textarea`](#textarea-form-field), `radio`, `select`, `number`, `checkbox`, `password`, `hidden`, `email`, `text`
93+
> [`text`](#text-form-field),
94+
> [`textarea`](#textarea-form-field),
95+
> [`radio`](#radio-form-field)
96+
> [`select`](#select-form-field)
97+
> [`number`](#number-form-field)
98+
> [`checkbox`](#checkbox-form-field),
99+
> [`password`](#password-form-field),
100+
> [`hidden`](#hidden-form-field),
101+
> [`email`](#email-form-field)
94102
95103
---
96104
##### templateUrl (string)
97-
`templateUrl` can be set instead of `type` to use a custom html template form field. Set a path relative to the root of the application. ie `directives/custom-field.html`
105+
>`templateUrl` can be set instead of `type` to use a custom html template form field. Set a path relative to the root of the application. ie `directives/custom-field.html`
98106
99107
###### Default
100-
`undefined`
108+
>`undefined`
101109
102110
---
103111
##### key (string)
104-
By default form results are keyed by location in the form array, you can override this by specifying a `key`.
112+
>By default form results are keyed by location in the form array, you can override this by specifying a `key`.
105113
106114
###### Default
107-
`undefined`
115+
>`undefined`
108116
109117
---
110118
##### label (string)
111-
`label` is used to add an html label to each field.
119+
>`label` is used to add an html label to each field.
112120
113121
###### Default
114-
A default is set for each field based on its type. ie `Text`, `Checkbox`, `Password`
122+
>A default is set for each field based on its type. ie `Text`, `Checkbox`, `Password`
115123
116124
---
117125
##### required (boolean)
118-
`required` is used to add the required attribute to a form field.
126+
>`required` is used to add the required attribute to a form field.
119127
120128
###### Default
121-
`undefined`
129+
>`undefined`
122130
123131
---
124132
##### disabled (boolean)
125-
`disabled` is used to add the disabled attribute to a form field.
133+
>`disabled` is used to add the disabled attribute to a form field.
126134
127135
###### Default
128-
`undefined`
136+
>`undefined`
129137
130138
---
131139
##### placeholder (string)
132-
`placeholder` is used to add placeholder text to some inputs.
140+
>`placeholder` is used to add placeholder text to some inputs.
133141
134142
###### Default
135-
`undefined`
143+
>`undefined`
136144
137145
### Form Fields
138146
#### Text form field
139-
The text field allows single line input with a input element set to `type='text'`. It doesn't have any custom properties.
147+
>The text field allows single line input with a input element set to `type='text'`. It doesn't have any custom properties.
140148
##### default (string)
141149

142150
_Example text field_
@@ -154,7 +162,7 @@ _Example text field_
154162
The textarea field creates multiline input with a textarea element.
155163
##### default (string)
156164
##### lines (number)
157-
`lines` sets the rows attribute for the textarea element.
165+
>`lines` sets the rows attribute for the textarea element.
158166
159167
_Example textarea field_
160168
```json
@@ -182,6 +190,14 @@ _Example checkbox field_
182190
}
183191
```
184192

193+
#### Radio form field
194+
#### Select form field
195+
#### Number form field
196+
#### Password form field
197+
#### Hidden form field
198+
#### Email form field
199+
200+
185201
## Roadmap
186202

187203
## Release Notes

0 commit comments

Comments
 (0)