Skip to content

Commit 44df17b

Browse files
committed
Add example image and correct typos.
1 parent 3953338 commit 44df17b

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Helper library to simplify **HTML5 Drag and Drop** in Dart.
66
## Features ##
77
* Make any HTML Element `draggable`.
88
* Create `dropzones` and connect them with `draggables`.
9-
* Rearrange elements with `sortable` (similar to jQuery UI Sortable).
9+
* Rearrange elements with `sortables` (similar to jQuery UI Sortable).
1010
* Support for `touch events` on touch screen devices.
1111
* Same functionality and API for IE9+, Firefox, Chrome and Safari.
1212
* Uses fast native HTML5 Drag and Drop of the browser whenever possible.
@@ -18,6 +18,8 @@ Helper library to simplify **HTML5 Drag and Drop** in Dart.
1818
See [HTML5 Drag and Drop in action](http://edu.makery.ch/projects/dart-html5-drag-and-drop)
1919
(with code examples).
2020

21+
[![Drag and Drop Example](https://raw.github.com/marcojakob/html5_dnd/master/doc/dnd-example.png)](http://edu.makery.ch/projects/dart-html5-drag-and-drop)
22+
2123
All examples are also available in the `example` directory on GitHub.
2224

2325
## Installation ##
@@ -43,6 +45,7 @@ See the demo page above or the `example` directory to see some live examples
4345
with code.
4446

4547
In general, to make drag and drop work, we will have to do two things:
48+
4649
1. Create draggables by installing HTML elements in a `DraggableGroup`.
4750
2. Create dropzones by installing HTML elements in a `DropzoneGroup`.
4851

@@ -185,7 +188,7 @@ listen to all their events.
185188

186189
#### Sortable Options ####
187190
In addition to the inherited `DraggableGroup` and `DropzoneGroup` options,
188-
`SortableGroup` as the following options:
191+
`SortableGroup` has the following options:
189192

190193
```dart
191194
SortableGroup sortGroup = new SortableGroup();
@@ -202,7 +205,8 @@ sortGroup.isGrid = false;
202205
```
203206

204207
#### Sortable Events ####
205-
There is one additional event for `SortableGroup`s:
208+
Next to the inherited `DraggableGroup` and `DropzoneGroup` events
209+
`SortableGroup` has one additional event:
206210

207211
```dart
208212
SortableGroup sortGroup = new SortableGroup();
@@ -213,7 +217,7 @@ sortGroup.onSortUpdate.listen((SortableEvent event) => print('elements were sort
213217

214218
## Thanks and Contributions ##
215219
I'd like to thank the people who kindly helped me with their answers or put
216-
some tutorial or code examples online. They've already contributed to this
220+
some tutorial or code examples online. They've indirectly contributed to this
217221
project.
218222

219223
If you'd like to contribute, you're welcome to report issues or

doc/dnd-example.png

30.6 KB
Loading

0 commit comments

Comments
 (0)