Add definition for "jquery.dropotron".

2026-09-11 11:50:54 +08:00 · 2015-01-30 13:13:46 +01:00
parent 77b4c9cb9a
commit 62c57a3c8a
3 changed files with 203 additions and 0 deletions
@@ -0,0 +1,160 @@
+// Type definitions for jquery.dropotron 1.4.3
+// Project: https://github.com/n33/jquery.dropotron
+// Definitions by: Cyril Schumacher <https://github.com/cyrilschumacher>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped/
+
+/**
+ * @summary Interface for "dropotron" configurations.
+ * @author  Cyril Schumacher
+ * @version 1.0
+ */
+interface DropotronConfiguration {
+    
+    /**
+     * @summary Alignment ("left", "center", "right").
+     * @type {string}
+     */
+    alignment: string;
+    
+    /**
+     * @summary Base Z-Index.
+     * @type {number}
+     */
+    baseZIndex: number;
+    
+    /**
+     * @summary If true and detach = true, leave original menu intact.
+     * @type {boolean}
+     */
+    cloneOnDetach: boolean;
+    
+    /**
+     * @summary Detach second level menus (prevents parent style bleed).
+     * @type {boolean}
+     */
+    detach: boolean;
+    
+    /**
+     * @summary Easing mode ("swing", "linear").
+     * @type {string}
+     */
+    easing: string;
+    
+    /**
+     * @summary IE Offset X.
+     * @type {number}
+     */
+    IEOffsetX: number;
+    
+    /**
+     * @summary IE Offset Y.
+     * @type {number}
+     */
+    IEOffsetY: number;
+    
+    /**
+     * @summary Expansion mode ("hover" or "click").
+     * @type {string}
+     */
+    expandMode: string;
+    
+    /**
+     * @summary Global offset Y.
+     * @type {number}
+     */
+    globalOffsetY: number;
+    
+    /**
+     * @summary Hide delay (in ms; 0 disables).
+     * @type {number}
+     */
+    hideDelay: number;
+    
+    /**
+     * @summary Hover delay (in ms).
+     * @type {number}
+     */
+    hoverDelay: number;
+    
+    /**
+     * @summary Menu class (assigned to every <ul>).
+     * @type {string}
+     */
+    menuClass: string;
+    
+    /**
+     * @summary Menu mode ("instant", "fade", "slide", "zoom").
+     * @type {string}
+     */
+    mode: string;
+    
+    /**
+     * @summary If true and mode = "fade", prevents top-level opener fade.
+     * @type {boolean}
+     */
+    noOpenerFade: boolean;
+    
+    /**
+     * @summary Submenu offset X.
+     * @type {number}
+     */
+    offsetX: number;
+    
+    /**
+     * @summary Submenu offset Y.
+     * @type {number}
+     */
+    offsetY: number;
+    
+    /**
+     * @summary Active opener class.
+     * @type {string}
+     */
+    openerActiveClass: string;
+    
+    /**
+     * @summary Opener class.
+     * @type {number}
+     */
+    openerClass: number;
+    
+    /**
+     * @summary Parent jQuery object.
+     * @type {JQuery}
+     */
+    selectorParent: JQuery;
+    
+    /**
+     * @summary Menu speed ("fast", "slow", or ms).
+     * @type {string}
+     */
+    speed: string;
+    
+    /**
+     * @summary Submenu class prefix.
+     * @type {string}
+     */
+    submenuClassPrefix: string;
+}
+
+/**
+ * @summary Interface for "dropotron".
+ * @author  Cyril Schumacher
+ * @version 1.0
+ */
+interface Dropotron {
+    /**
+     * @summary Adds multilevel dropdown menus to jQuery.
+     * @param {DropotronConfiguration} config Optional. Configuration.
+     */
+    (config?: DropotronConfiguration): void;
+}
+
+/**
+ * @summary Interface for "JQuery".
+ * @author  Cyril Schumacher
+ * @version 1.0
+ */
+interface JQuery {
+    dropotron: Dropotron;
+}