Add tether typings

2026-09-09 11:13:57 +08:00 · 2015-03-04 21:08:20 -05:00
parent fe39944e4d
commit 68ae7bb60d
2 changed files with 103 additions and 0 deletions
@@ -0,0 +1,50 @@
+// Type definitions for Tether v0.6
+// Project: http://github.hubspot.com/tether/
+// Definitions by: Adi Dahiya <https://github.com/adidahiya>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module tether {
+
+    interface TetherStatic {
+        new(options: ITetherOptions): Tether;
+    }
+
+    interface ITetherOptions {
+        attachment?: string;
+        classes?: {[className: string]: boolean};
+        classPrefix?: string;
+        constraints?: ITetherConstraint[];
+        element?: Element | string | any /* JQuery */;
+        enabled?: boolean;
+        offset?: string;
+        optimizations?: any;
+        target?: Element | string | any /* JQuery */;
+        targetAttachment?: string;
+        targetOffset?: string;
+        targetModifier?: string;
+    }
+
+    interface ITetherConstraint {
+        attachment?: string;
+        outOfBoundsClass?: string;
+        pin?: boolean | string[];
+        pinnedClass?: string;
+        to?: string | Element | number[];
+    }
+
+    interface Tether {
+        setOptions(options: ITetherOptions): void;
+        disable(): void;
+        enable(): void;
+        destroy(): void;
+        position(): void;
+    }
+
+}
+
+declare module "tether" {
+    export = tether;
+}
+
+declare var Tether: tether.TetherStatic;
+