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

Commit 3f3b42c

Browse files
author
Kent C. Dodds
committed
Updating some documentation
1 parent 02898cb commit 3f3b42c

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ NOTE: All of these properties will be under the `templateOptions` property as of
5252
>`label` is used to add an html label to each field.
5353
5454
###### Default
55-
>A default is set for each field based on its type. ie `Text`, `Checkbox`, `Password`
55+
>`undefined`
5656
5757
---
5858
##### required (boolean)
@@ -105,8 +105,6 @@ Below is a detailed description of each form fields and its custom properties.
105105
#### Input form field
106106
>The input uses the <input> element and allows you to specify it's type via the type property
107107
108-
##### default (string, optional)
109-
110108
_Example text field_
111109
```json
112110
{
@@ -124,8 +122,6 @@ _Example text field_
124122
#### Textarea form field
125123
>The textarea field creates multiline input with a textarea element.
126124
127-
##### default (string, optional)
128-
129125
##### lines (number, optional)
130126
>`lines` sets the rows attribute for the textarea element.
131127
@@ -147,8 +143,6 @@ _Example textarea field_
147143
#### Checkbox form field
148144
>The checkbox field allows checkbox input with a input element set to `type='checkbox'`. It doesn't have any custom properties.
149145
150-
##### default (boolean, optional)
151-
152146
_Example checkbox field_
153147
```json
154148
{
@@ -196,12 +190,23 @@ _Example radio field_
196190
#### Select form field
197191
>The select field allows selection via dropdown using the select element.
198192
199-
##### default (number, optional)
200-
>The default can be set to the index of one of the `options`.
201-
202193
##### options (array, required)
203194
>`options` is an array of options for the select form field to display. Each option should be an object with a `name`(string). You may optionally add a `group` to some or all of your options.
204195
196+
##### labelProp (string, optional)
197+
>`labelProp` is what is used for what is shown to the user. Defaults to `name`
198+
199+
##### valueProp (string, optional)
200+
>`valueProp` is what is used for the value assigned to the model. Defaults to `value`
201+
202+
##### groupProp (string, optional)
203+
>`groupProp` is what is used to group the options
204+
205+
##### ngOptions (string, optional)
206+
>If provided, this is used instead of the default `ng-options` giving you full control (and rendering the other options uncessisary.
207+
208+
[Example](http://angular-formly.com/#/example/bootstrap-formly/select)
209+
205210
_Example select field_
206211
```json
207212
{

0 commit comments

Comments
 (0)