Merge pull request DefinitelyTyped#4671 from EnableSoftware/Add-ScrollToFixed

Add definitions for ScrollToFixed

Author: horiuchi

scrolltofixed/scrolltofixed-tests.ts

@@ -0,0 +1,34 @@
+/// <reference path="scrolltofixed.d.ts" />
+
+$(document).ready(function() {
+  $('#mydiv').scrollToFixed();
+});
+
+$(document).ready(function() {
+    $('.header').scrollToFixed({
+        preFixed: function() { $(this).find('h1').css('color', 'blue'); },
+        postFixed: function() { $(this).find('h1').css('color', ''); }
+    });
+
+    $('.footer').scrollToFixed( {
+        bottom: 0,
+        limit: $('.footer').offset().top,
+        preFixed: function() { $(this).find('h1').css('color', 'blue'); },
+        postFixed: function() { $(this).find('h1').css('color', ''); }
+    });
+
+    $('#summary').scrollToFixed({
+        marginTop: $('.header').outerHeight() + 10,
+        limit: function() {
+            var limit = $('.footer').offset().top - $('#summary').outerHeight(true) - 10;
+            return limit;
+        },
+        zIndex: 999,
+        preFixed: function() { $(this).find('.title').css('color', 'blue'); },
+        preAbsolute: function() { $(this).find('.title').css('color', 'red'); },
+        postFixed: function() { $(this).find('.title').css('color', ''); },
+        postAbsolute: function() { $(this).find('.title').css('color', ''); }
+    });
+});
+
+var b = $.isScrollToFixed('.header');

scrolltofixed/scrolltofixed.d.ts

@@ -0,0 +1,49 @@
+// Type definitions for ScrollToFixed
+// Project: https://github.com/bigspotteddog/ScrollToFixed
+// Definitions by: Ben Dixon <https://github.com/bmdixon>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module ScrollToFixed {
+	interface ScrollToFixedOptions {
+		marginTop? : number | (() => number);		
+		limit? : number | (() => number);
+		bottom?: number;
+		zIndex? : number;
+		spacerClass? : string;
+		preFixed?: () => void;
+		postFixed?: () => void;
+		fixed?: () => void;
+		unfixed?: () => void;
+		preUnfixed?: () => void;
+		postUnfixed?: () => void;
+		preAbsolute?: () => void;
+		postAbsolute?: () => void;
+		offsets? : boolean;
+		minWidth? : number;
+		maxWidth? : number;
+		dontCheckForPositionFixedSupport? : boolean;
+		dontSetWidth? : boolean;
+		removeOffsets? : boolean;
+		baseClassName?: string;
+		className?: string;
+	}
+}
+
+interface JQuery {	
+    scrollToFixed : (options? : ScrollToFixed.ScrollToFixedOptions) => JQuery[];
+}
+
+interface JQueryStatic {
+	isScrollToFixed(el: Element) : JQuery;
+	isScrollToFixed(el: Element[]) : JQuery;
+	isScrollToFixed(el: {}) : JQuery;
+	isScrollToFixed(el: JQuery) : JQuery;
+	
+    ScrollToFixed(el: Element, options: ScrollToFixed.ScrollToFixedOptions): void;
+	ScrollToFixed(el : Element, options : ScrollToFixed.ScrollToFixedOptions) : JQuery;
+	ScrollToFixed(el: Element[], options : ScrollToFixed.ScrollToFixedOptions) : JQuery;
+	ScrollToFixed(el: {}, options : ScrollToFixed.ScrollToFixedOptions) : JQuery;
+	ScrollToFixed(el: JQuery, options : ScrollToFixed.ScrollToFixedOptions) : JQuery;	
+}