Skip to content

Commit 1b63ef4

Browse files
committed
updated docs
1 parent 86257d1 commit 1b63ef4

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
#vue-formly-bootstrap
2-
A plugin for [Vue Formly](https://github.com/matt-sanders/vue-formly) which adds multiple form fields according to Twitter Bootstrap.
2+
A plugin for [Vue Formly](https://github.com/matt-sanders/vue-formly) which adds multiple form fields according to Twitter Bootstrap.
33

44
##Installation
55
```
66
npm install vue-formly-bootstrap
77
```
88
or if you can just include the script:
99
```html
10-
<script src="/path_to_folder/vue-formly-bootstrap/dist/vue-formly-bootstrap.js"></script>
10+
<link rel="stylesheet" href="/path_to_bootstrap.css"/>
11+
<script src="/path_to_bootstrap.js"></script>
12+
<script src="/path_to_folder/vue-formly-bootstrap/dist/vue-formly-bootstrap.min.js"></script>
1113
```
1214

1315
##Usage
@@ -50,7 +52,9 @@ let vm = new Vue({
5052
```
5153
If you include the script it will be installed for you.
5254

53-
Note that this is still a work in progress so some fields are under construction. See the To Do section for what's on the watchlist.
55+
For more advanced details about how to use Vue Formly check out the [docs](https://www.gitbook.com/book/matt-sanders/vue-formly/details).
56+
57+
Note that this is still a work in progress so some fields are under construction. See the [To Do](#to-do) section for what's on the watchlist.
5458

5559
##Options
5660

@@ -61,6 +65,7 @@ These options are used by all the different field types. Some fields may have sp
6165
| --- | --- | --- | --- |
6266
| $dirty | `boolean` | `false` | ***RESTRICTED*** This is set by the system and is just there for your reference. It gets set to `true` upon blur or change, whichever happens first. |
6367
| $active | `boolean` | `false` | ***RESTRICTED*** Also set by the system and is set to true on focus. |
68+
| type | `string` | `null` | ***REQUIRED*** this is the input type. Check the [Available Inputs](#available-inputs) section for a list of currently available inputs.
6469
| onBlur | `function(e)` | `null` | A function to run on @blur event |
6570
| onFocus | `function(e)` | `null` | A function to run on @focus event |
6671
| onClick | `function(e)` | `null` | A function to run on @click event |
@@ -85,6 +90,13 @@ These options are used by all the different field types. Some fields may have sp
8590
| --- | --- | --- | --- |
8691
| options | `array` | `null` | Pass either an array of strings or objects. Objects require a `label` and `value` property. If a string is passed then it will be used for the value and the label. eg: `options: ['Foo', 'Bar']` or `options: [{ label: 'Foo', value: 'bar'},{label: 'Bar', value: 'foo'}] |
8792

93+
##Available Inputs
94+
* input
95+
* select
96+
* textarea
97+
* checkbox
98+
* radio
99+
88100
##To Do
89101
* [x] Input
90102
* [x] Select

0 commit comments

Comments
 (0)