Add angular-scroll definitions

2026-08-16 23:10:29 +00:00 · 2015-01-05 22:57:16 -05:00
parent 494b30d232
commit 24e9266e49
2 changed files with 108 additions and 0 deletions
@@ -0,0 +1,64 @@
+/// <reference path="angular-scroll.d.ts" />
+
+module TestApp {
+
+    class TestController {
+
+        constructor($scope: ng.IScope, $document: duScroll.IDocumentService) {
+            var positionFromTop = 400;
+            var positionFromLeft = 200;
+            var offsetInPixels = 100;
+            var durationInMillis = 2000;
+            var someElement: ng.IAugmentedJQuery;
+
+            $document.duScrollTo(positionFromLeft, positionFromTop);
+            $document.duScrollTo(positionFromLeft, positionFromTop, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollTo(positionFromLeft, positionFromTop, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollTo(someElement);
+            $document.duScrollTo(someElement, offsetInPixels);
+            $document.duScrollTo(someElement, offsetInPixels, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollTo(someElement, offsetInPixels, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollToElement(someElement);
+            $document.duScrollToElement(someElement, offsetInPixels);
+            $document.duScrollToElement(someElement, offsetInPixels, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollToElement(someElement, offsetInPixels, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollToElementAnimated(someElement).then(this.onScrollCompleted);
+            $document.duScrollToElementAnimated(someElement, offsetInPixels).then(this.onScrollCompleted);
+            $document.duScrollToElementAnimated(someElement, offsetInPixels, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollToElementAnimated(someElement, offsetInPixels, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollTop(positionFromTop);
+            $document.duScrollTop(positionFromTop, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollTop(positionFromTop, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollTopAnimated(positionFromTop).then(this.onScrollCompleted);
+            $document.duScrollTopAnimated(positionFromTop, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollTopAnimated(positionFromTop, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollLeft(positionFromLeft);
+            $document.duScrollLeft(positionFromLeft, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollLeft(positionFromLeft, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            $document.duScrollLeftAnimated(positionFromLeft).then(this.onScrollCompleted);
+            $document.duScrollLeftAnimated(positionFromLeft, durationInMillis).then(this.onScrollCompleted);
+            $document.duScrollLeftAnimated(positionFromLeft, durationInMillis, this.invertedEasingFn).then(this.onScrollCompleted);
+
+            var verticalPosition: number = $document.duScrollTop();
+            var horixontalPosition: number = $document.duScrollLeft();
+        }
+
+        private invertedEasingFn = (x: number): number => {
+            return 1 - x;
+        }
+
+        private onScrollCompleted = (): void => {
+            console.log('Done scrolling');
+        }
+    }
+
+    angular.module('testApp', ['duScroll'])
+        .controller('testController', TestController);
+}
@@ -0,0 +1,44 @@
+// Type definitions for angular-scroll
+// Project: https://github.com/oblador/angular-scroll
+// Definitions by: Sam Herrmann <https://github.com/samherrmann>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module duScroll {
+
+    /**
+     * Extends the angular.element object returned by the $document sercive with a few jQuery like functions.
+     * see https://github.com/oblador/angular-scroll#angularelement-scroll-api
+     */
+    interface IDocumentService extends ng.IDocumentService {
+
+        duScrollTo(left: number, top: number): void;
+        duScrollTo(left: number, top: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollTo(element: ng.IAugmentedJQuery, offset?: number): void;
+        duScrollTo(element: ng.IAugmentedJQuery, offset: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollToElement(element: ng.IAugmentedJQuery, offset?: number): void;
+        duScrollToElement(element: ng.IAugmentedJQuery, offset: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollToElementAnimated(element: ng.IAugmentedJQuery, offset?: number): ng.IPromise<void>;
+        duScrollToElementAnimated(element: ng.IAugmentedJQuery, offset: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollTop(top: number): void;
+        duScrollTop(top: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollTopAnimated(top: number): ng.IPromise<void>;
+        duScrollTopAnimated(top: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollLeft(left: number): void;
+        duScrollLeft(left: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollLeftAnimated(left: number): ng.IPromise<void>;
+        duScrollLeftAnimated(left: number, duration: number, easing?: Function): ng.IPromise<void>;
+
+        duScrollTop(): number;
+        duScrollLeft(): number;
+    }
+}