Skip to content

Commit e62980c

Browse files
authored
Merge pull request #37 from Zearin/patch-1
Update README.md
2 parents 4cd6297 + 9fd3159 commit e62980c

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.md

+19-22
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
#### Fixed size grid for Vue.js
77

8-
This is very a first version of the plugin. If you find any bugs and/or want to contribute, feel free to create issues, PRs or reach me out on twitter! 👍 🚀
8+
This is very a first version of the plugin. If you find any bugs and/or want to contribute, feel free to create issues, PRs, or reach me out on twitter! 👍 🚀
99

1010
Thanks!
1111

12-
<p align="center">
12+
<p style="text-align:center">
1313
<img src="https://user-images.githubusercontent.com/1577802/30805846-45ccd718-a1eb-11e7-9963-7aee8e76c9b0.gif">
1414
</p>
1515

@@ -62,36 +62,33 @@ Plugin does **NOT** modify the source data array.
6262
6363
| Name | Type | Default | Description |
6464
| --- | --- | --- | --- |
65-
| items | Array | [] | Initial array of items |
66-
| cellWidth | Number | 80 | Cell width |
67-
| cellHeight | Number | 80 | Cell height |
68-
| draggable | Boolean | false | Flag that will let you drag grid's cells |
69-
| dragDelay | Number | 0 | @TODO |
70-
| sortable | Boolean | false | Flag that will let you reorder grid's cells, requires `draggable` to be `true` |
71-
| center | Boolean | false | @TODO |
65+
| `items` | Array | `[]` | Initial array of items |
66+
| `cellWidth` | Number | `80` | Cell width |
67+
| `cellHeight` | Number | `80` | Cell height |
68+
| `draggable` | Boolean | `false` | Flag that will let you drag grid's cells |
69+
| `dragDelay` | Number | `0` | @TODO |
70+
| `sortable` | Boolean | `false` | Flag that will let you reorder grid's cells; requires `draggable` to be `true` |
71+
| `center` | Boolean | `false` | @TODO |
7272
7373
### Events
7474
7575
| Name | Description |
7676
| --- | --- |
77-
| @change | Occurs on every action that involves reordering array or changing it's length |
78-
| @remove | Occurs when an element is deleted through template |
79-
| @click | Occurs when cell is clicked |
80-
| @sort | Occurs when array item order is changed manually |
77+
| `@change` | Occurs on every action that involves reordering array or changing its length |
78+
| `@remove` | Occurs when an element is deleted through template |
79+
| `@click` | Occurs when cell is clicked |
80+
| `@sort` | Occurs when array item order is changed manually |
8181
8282
### Cell template
8383
84-
Cell template is used to get access to list data, indexing and sorting params generated by plugin.
84+
Cell template is used to get access to list data, indexing, and sorting params generated by plugin.
8585
8686
Template's scope contains:
8787
88-
`props.item` - list item value
89-
90-
`props.index` - initial index of the item
91-
92-
`props.sort` - current index of an item after sorting
93-
94-
`props.remove()` - method that will remove item from the arrey and resport list.
88+
* `props.item`: list item value
89+
* `props.index`: initial index of the item
90+
* `props.sort`: current index of the item after sorting
91+
* `props.remove()`: method that removes the item from the array and resort list.
9592
9693
Example:
9794
@@ -103,7 +100,7 @@ Example:
103100
</template>
104101
```
105102
106-
### Why do i need this?
103+
### Why do I need this?
107104
108105
A good example of using a plugin would be rending macOS' `Launchpad` or `Dock`. Check out a demo for a solid example of how the plugin behaves & feels.
109106

0 commit comments

Comments
 (0)