Merge pull request #407 from bahung1221/master

Add TypeScript types for SortAnimation and update correct CDN link README
Shopify · Jul 14, 2020 · 6bcc42e · 6bcc42e
2 parents 9af30e7 + aeb0a87
commit 6bcc42e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -172,6 +172,7 @@ declare module '@shopify/draggable' {
         mirror?: MirrorOptions;
         scrollable?: ScrollableOptions;
         swapAnimation?: SwapAnimationOptions;
+        sortAnimation?: SortAnimationOptions;
     }
 
     export class Draggable<EventListType = DraggableEventNames> {
@@ -510,9 +511,23 @@ declare module '@shopify/draggable' {
         protected detach(): void;
     }
 
+    /**
+     * SortAnimation
+     */
+    export interface SortAnimationOptions {
+        duration?: number;
+        easingFunction?: string;
+    }
+
+    class SortAnimation extends AbstractPlugin {
+        protected attach(): void;
+        protected detach(): void;
+    }
+
     export const Plugins: {
         Collidable: typeof Collidable,
         SwapAnimation: typeof SwapAnimation,
+        SortAnimation: typeof SortAnimation,
         ResizeMirror: typeof ResizeMirror,
         Snappable: typeof Snappable,
     };

diff --git a/src/Plugins/SortAnimation/README.md b/src/Plugins/SortAnimation/README.md
@@ -21,11 +21,11 @@ import SortAnimation from '@shopify/draggable/lib/plugins/sort-animation';
 ```
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.8/lib/plugins.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.10/lib/plugins.js"></script>
 ```
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.8/lib/plugins/sort-animation.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.10/lib/plugins/sort-animation.js"></script>
 ```
 
 ### API