Skip to content

Commit 1bb7b76

Browse files
committed
Message that it is not maintained any more
1 parent 9da6e11 commit 1bb7b76

File tree

2 files changed

+45
-43
lines changed

2 files changed

+45
-43
lines changed

README.md

+42-40
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
HTML5 Drag and Drop for Dart
2-
================
1+
# HTML5 Drag and Drop for Dart
2+
3+
***
4+
5+
### Note: This library is not maintained any more.
6+
7+
* Use the [Dart drag and drop](http://code.makery.ch/library/dart-drag-and-drop/) library instead (better, without HTML5).
8+
* Read the details about why I chose [Drag and Drop without HTML5](http://code.makery.ch/blog/drag-and-drop-without-html5/)
9+
10+
***
11+
12+
13+
314

415
Helper library to simplify **HTML5 Drag and Drop** in Dart.
516

6-
## Features ##
17+
## Features
18+
719
* Make any HTML Element `draggable`.
820
* Create `dropzones` and connect them with `draggables`.
921
* Rearrange elements with `sortables` (similar to jQuery UI Sortable).
@@ -14,33 +26,9 @@ Helper library to simplify **HTML5 Drag and Drop** in Dart.
1426
This is the case for IE9 and partly for IE10 (when custom drag images are
1527
used).
1628

17-
## Demo ##
18-
See [HTML5 Drag and Drop in action](http://edu.makery.ch/projects/dart-html5-drag-and-drop)
19-
(with code examples).
2029

21-
[![Drag and Drop Example](https://raw.github.com/marcojakob/dart-html5-dnd/master/doc/dnd-example.png)](http://edu.makery.ch/projects/dart-html5-drag-and-drop)
30+
## Usage
2231

23-
All examples are also available in the `example` directory on GitHub.
24-
25-
## Installation ##
26-
27-
### Add Dependency ###
28-
Add the folowing to your **pubspec.yaml** and run **pub install**
29-
```yaml
30-
dependencies:
31-
html5_dnd: any
32-
```
33-
34-
### Import ###
35-
Import the `html5_dnd` library in your Dart code.
36-
37-
```dart
38-
import 'package:html5_dnd/html5_dnd.dart';
39-
40-
// ...
41-
```
42-
43-
## Usage ##
4432
See the demo page above or the `example` directory to see some live examples
4533
with code.
4634

@@ -54,14 +42,16 @@ elements in a `SortableGroup`. The `SortableGroup` will make the installed
5442
elements both into draggables and dropzones and thus creates sortable behaviour.
5543

5644

57-
### Disable Touch Support ###
45+
### Disable Touch Support
46+
5847
There is a global property called `enableTouchEvents` which is `true` by
5948
default. This means that touch events are automatically enabled on devices that
6049
support it. If touch support should not be used even on touch devices, set this
6150
flag to `false`.
6251

6352

64-
### Draggables ###
53+
### Draggables
54+
6555
Any HTML element can be made draggable. First we'll have to create a
6656
`DraggableGroup` that manages draggable elements. The `DraggableGroup` holds
6757
all options for dragging and provides event streams we can listen to.
@@ -78,7 +68,9 @@ dragGroup.installAll(queryAll('.my-draggables'));
7868
With `uninstall(...)` or `uninstallAll(...)` draggables can be removed from
7969
the group and the draggable behaviour is uninstalled.
8070

81-
#### Draggable Options ####
71+
72+
#### Draggable Options
73+
8274
The `DraggableGroup` has three constructor options:
8375

8476
* The `dragImageFunction` is used to provide a custom `DragImage`. If no
@@ -128,7 +120,8 @@ dragGroup.overClass = 'dnd-over';
128120
dragGroup.dropEffect = DROP_EFFECT_COPY;
129121
```
130122

131-
#### Draggable Events ####
123+
#### Draggable Events
124+
132125
We can listen to `dragStart`, `drag`, and `dragEnd` events of a
133126
`DraggableGroup`.
134127

@@ -141,7 +134,8 @@ dragGroup.onDragEnd.listen((DraggableEvent event) => print('drag ended'));
141134
```
142135

143136

144-
### Dropzones ###
137+
### Dropzones
138+
145139
Any HTML element can be made to a dropzone. Similar to how draggables are
146140
created, we create a dropzones:
147141

@@ -151,7 +145,8 @@ DropzoneGroup dropGroup = new DropzoneGroup();
151145
dropGroup.installAll(queryAll('.my-dropzones'));
152146
```
153147

154-
#### Dropzone Options ####
148+
#### Dropzone Options
149+
155150
The `DropzoneGroup` has an option to specify which `DraggableGroup`s it accepts.
156151
If no accept group is specified, the `DropzoneGroup` will accept all draggables.
157152

@@ -166,7 +161,8 @@ DropzoneGroup dropGroup = new DropzoneGroup();
166161
dropGroup.accept.add(dragGroup);
167162
```
168163

169-
#### Dropzone Events ####
164+
#### Dropzone Events
165+
170166
We can listen to `dragEnter`, `dragOver`, `dragLeave`, and `drop` events of a
171167
`DropzoneGroup`.
172168

@@ -180,7 +176,8 @@ dropGroup.onDrop.listen((DropzoneEvent event) => print('dropped inside'));
180176
```
181177

182178

183-
### Sortables ###
179+
### Sortables
180+
184181
For reordering of HTML elements we can use sortables.
185182

186183
```dart
@@ -193,7 +190,9 @@ Note: All sortables are at the same time draggables and dropzones. This means
193190
we can set all options of `DraggableGroup` and `DropzoneGroup` on sortables and
194191
listen to all their events.
195192

196-
#### Sortable Options ####
193+
194+
#### Sortable Options
195+
197196
In addition to the inherited `DraggableGroup` and `DropzoneGroup` options,
198197
`SortableGroup` has the following options:
199198

@@ -211,7 +210,8 @@ sortGroup.forcePlaceholderSize = true;
211210
sortGroup.isGrid = false;
212211
```
213212

214-
#### Sortable Events ####
213+
#### Sortable Events
214+
215215
Next to the inherited `DraggableGroup` and `DropzoneGroup` events
216216
`SortableGroup` has one additional event:
217217

@@ -222,7 +222,8 @@ sortGroup.onSortUpdate.listen((SortableEvent event) => print('elements were sort
222222
```
223223

224224

225-
## Thanks and Contributions ##
225+
## Thanks and Contributions
226+
226227
I'd like to thank the people who kindly helped me with their answers or put
227228
some tutorial or code examples online. They've indirectly contributed to this
228229
project.
@@ -233,5 +234,6 @@ If you'd like to contribute, you're welcome to report issues or
233234

234235

235236

236-
## License ##
237+
## License
238+
237239
The MIT License (MIT)

pubspec.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: html5_dnd
2-
version: 0.3.5
2+
version: 0.3.6
33
author: Marco Jakob <[email protected]>
4-
description: HTML5 Drag and Drop
4+
description: HTML5 Drag and Drop (not maintained any more)
55
homepage: https://github.com/marcojakob/dart-html5-dnd
6-
documentation: http://edu.makery.ch/projects/dart-html5-drag-and-drop
6+
documentation: http://code.makery.ch/dart/html5-drag-and-drop/
77
dependencies:
88
logging: '>=0.9.0 <0.10.0'
99
dev_dependencies:

0 commit comments

Comments
 (0)