Cleanup for v1.0

marcojakob · Jun 13, 2018 · 5600695 · 5600695
1 parent a9f1be2
commit 5600695
Show file tree

Hide file tree

Showing 13 changed files with 105 additions and 111 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,94 +1,94 @@
 # Changelog
 
-## Version 1.0.0-alpha+1 (2018-05-05)
+## Version 1.0.0 (2018-06-13)
 
-* Migrate to Dart 2.
-* Use pointer events for Edge, Firefox, Chrome.
+- Migrate to Dart 2.
+- Since Chrome 56 touch event listeners are [treated as passive by default](https://www.chromestatus.com/features/5093566007214080). This disables the possibility to call `preventDefault` on an element which we must do to tell the browser not to scroll while dragging. To fix this in Chrome we set the `touch-action` css property. With this Chrome will not scroll (`none`) or only scroll in one direction (`pan-y` or `pan-x`).
 
 ## Version 0.4.0 (2017-06-27)
 
-* Fix strong mode errors (#20).
+- Fix strong mode errors (#20).
 
 ## Version 0.3.6 (2017-06-06)
 
-* Fix bug: Provide reasonable fallback for event target when mouse position exits viewport (#19).
+- Fix bug: Provide reasonable fallback for event target when mouse position exits viewport (#19).
 
 ## Version 0.3.5 (2016-11-22)
 
-* Handle the edge case where destroy is called while dragging an avatar (#17).
+- Handle the edge case where destroy is called while dragging an avatar (#17).
 
 ## Version 0.3.4 (2016-10-19)
 
-* Fix strong-mode type errors (#15).
-* Remove Shadow DOM example and (dev)dependency on Polymer (was causing some confusion).
+- Fix strong-mode type errors (#15).
+- Remove Shadow DOM example and (dev)dependency on Polymer (was causing some confusion).
 
 ## Version 0.3.3 (2016-09-22)
 
-* Allow a configurable clickSuppression distance (#13). We found that the click
+- Allow a configurable clickSuppression distance (#13). We found that the click
   suppression was a little too aggressive for users with less mousing accuracy.
   They would attempt to click and trigger a small drag. Which then suppressed the
   click event and prevented the action they intended to complete.
 
 ## Version 0.3.2 (2016-07-26)
 
-* Remove null-aware operator since drone.io uses an old version of Dart that doesn't support this yet.
+- Remove null-aware operator since drone.io uses an old version of Dart that doesn't support this yet.
 
 ## Version 0.3.1 (2016-07-26)
 
-* Support for programmatic drag abort (see issue #11).
+- Support for programmatic drag abort (see issue #11).
 
 ## Version 0.3.0 (2015-04-18)
 
-* BREAKING CHANGE: Refactoring the `AvatarHandler`. Only if you've
+- BREAKING CHANGE: Refactoring the `AvatarHandler`. Only if you've
   implemented a custom `AvatarHandler` you might need to do some changes:
-  * `setPointerEventsNone` and `resetPointerEvents` were removed and don't
+  - `setPointerEventsNone` and `resetPointerEvents` were removed and don't
     need to be called any more. Pointer event styles are handled automatically.
-* Fix `AvatarHandler` margin caching: The `AvatarHandler` only cached the
+- Fix `AvatarHandler` margin caching: The `AvatarHandler` only cached the
   margins once for every `Draggable`. This caused problems when margins of
   elements in the same `Draggable` had different margins or the margins were
   changed. Now the margins are reset after every drag.
 
 ## Version 0.2.1 (2015-03-09)
 
-* Fix #9: Using transformers in the main `pubspec.yaml` caused problems with
+- Fix #9: Using transformers in the main `pubspec.yaml` caused problems with
   projects depending on the `dnd` package.
 
 ## Version 0.2.0 (2015-03-09)
 
-* Fix #3: Shadow DOM is now supported. A `dnd-retarget` attribute must be added
+- Fix #3: Shadow DOM is now supported. A `dnd-retarget` attribute must be added
   to all custom elements where events should be forwarded to the Shadow DOM
   children.
-* Fix #7: Add a css class (`dnd-invalid` by default) to dropzones when a
+- Fix #7: Add a css class (`dnd-invalid` by default) to dropzones when a
   not-accepted draggable is dragged over.
 
 ## Version 0.1.4 (2014-10-20)
 
-* Add a sortable example.
-* Change comments according to new Dart Style Guide rule
+- Add a sortable example.
+- Change comments according to new Dart Style Guide rule
   (`///` instead of `/** */`).
-* Move event dispatching calls from EventManager to Draggable (refactoring).
+- Move event dispatching calls from EventManager to Draggable (refactoring).
 
 ## Version 0.1.3 (2014-08-09)
 
-* Fix #4: Problem when an ancestor of the dragged element was positioned
+- Fix #4: Problem when an ancestor of the dragged element was positioned
   (relative, absolute, fixed).
 
 ## Version 0.1.2 (2014-07-22)
 
-* Correcting small bug that occurred when setSelectionRange() was called on
+- Correcting small bug that occurred when setSelectionRange() was called on
   an element that does not support it.
-* Fix Pointer Event bug: Too many event listeners in move, end, cancel.
-* Fix for Bug #1 - Not working in Windows 8.1 IE11
-* Adding a `cancelled` flag to `DraggableEvent` to indicate if a drag ended
+- Fix Pointer Event bug: Too many event listeners in move, end, cancel.
+- Fix for Bug #1 - Not working in Windows 8.1 IE11
+- Adding a `cancelled` flag to `DraggableEvent` to indicate if a drag ended
   because of a cancelling operation like `esc` key, etc.
 
 ## Version 0.1.1 (2014-07-21)
 
-* Support for IE10 and IE11 touch screens through pointer events.
-* Removed `disableTouch` and `disableMouse` options. The goal was to unify
+- Support for IE10 and IE11 touch screens through pointer events.
+- Removed `disableTouch` and `disableMouse` options. The goal was to unify
   touch and mouse dragging, so it should not be necessary to disable
   one or the other.
 
 ## Version 0.1.0 (2014-07-17)
 
-* First version.
+- First version.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Marco Jakob
+Copyright (c) 2018 Marco Jakob
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/example/index.html b/example/index.html
@@ -54,6 +54,19 @@ <h1>Dart Drag and Drop Examples</h1>
         <a href="simple_sortable/">Sortable</a>
       </li>
     </ul>
+
+    <h2>Just for Testing</h2>
+    <p>
+      The following examples are used for testing purposes:
+    </p>
+    <ul>
+      <li>
+        <a href="parent_offset/">Parent Offset</a>
+      </li>
+      <li>
+        <a href="scroll_offset/">Scroll Offset</a>
+      </li>
+    </ul>
   </div>
 </body>
 

diff --git a/test/parent-offset/example.css → example/parent_offset/example.css b/test/parent-offset/example.css → example/parent_offset/example.css
diff --git a/test/parent-offset/example.dart → example/parent_offset/example.dart b/test/parent-offset/example.dart → example/parent_offset/example.dart
diff --git a/example/parent_offset/index.html b/example/parent_offset/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport"
+        content="width=device-width, initial-scale=1">
+
+  <title>Dart Drag and Drop: Parent Offset Test</title>
+
+  <link rel="stylesheet"
+        href="example.css">
+  <script defer
+          src="example.dart.js"></script>
+</head>
+
+<body>
+  <div class="container">
+    <a href="https://github.com/marcojakob/dart-dnd/tree/master/example/parent_offset"
+       target="_parent">Example Source on GitHub</a>
+    <div class="draggable">
+      <p>Drag me!</p>
+    </div>
+  </div>
+</body>
+
+</html>
diff --git a/test/scroll-offset/example.css → example/scroll_offset/example.css b/test/scroll-offset/example.css → example/scroll_offset/example.css
diff --git a/test/scroll-offset/example.dart → example/scroll_offset/example.dart b/test/scroll-offset/example.dart → example/scroll_offset/example.dart
diff --git a/example/scroll_offset/index.html b/example/scroll_offset/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport"
+        content="width=device-width, initial-scale=1">
+
+  <title>Dart Drag and Drop: Scroll Offset Test</title>
+
+  <link rel="stylesheet"
+        href="example.css">
+  <script defer
+          src="example.dart.js"></script>
+</head>
+
+<body>
+  <div class="container">
+    <a href="https://github.com/marcojakob/dart-dnd/tree/master/example/scroll_offset"
+       target="_parent">Example Source on GitHub</a>
+    <div class="draggable">
+      <p>Drag me!</p>
+    </div>
+
+    <div class="dropzone">
+      Scroll down and drag!
+    </div>
+  </div>
+</body>
+
+</html>
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,12 +1,10 @@
 name: dnd
-version: 1.0.0-alpha+1
+version: 1.0.0
 author: Marco Jakob <[email protected]>
 description: Drag and Drop for Dart web apps with mouse and touch support.
 homepage: http://code.makery.ch/library/dart-drag-and-drop/
-documentation: https://www.dartdocs.org/documentation/dnd/latest/
 environment:
   sdk: '>=2.0.0-dev.46.0 <2.0.0'
-
 dev_dependencies:
-  build_runner: ^0.8.7
-  build_web_compilers: ^0.3.7
+  build_runner: ^0.8.9
+  build_web_compilers: ^0.4.0
diff --git a/test/parent-offset/index.html b/test/parent-offset/index.html
diff --git a/test/scroll-offset/index.html b/test/scroll-offset/index.html
diff --git a/tool/drone_io.sh b/tool/drone_io.sh