Add angular-scroll definitions

2026-08-12 13:00:19 +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,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;
+    }
+}