mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-23 21:00:01 +08:00
Added typings for jquery.menuaim (https://github.com/kamens/jQuery-menu-aim)
This commit is contained in:
12
jquery.menuaim/jquery.menuaim-tests.ts
Normal file
12
jquery.menuaim/jquery.menuaim-tests.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
/// <reference path="../jquery/jquery.d.ts" />
|
||||
/// <reference path="jquery.menuaim.d.ts" />
|
||||
$('div').menuAim({
|
||||
activate: function () { },
|
||||
deactivate: function () { },
|
||||
enter: function () { },
|
||||
exit: function () { },
|
||||
exitMenu: function () { },
|
||||
rowSelector: "> li",
|
||||
submenuSelector: "*",
|
||||
submenuDirection: "right"
|
||||
});
|
||||
61
jquery.menuaim/jquery.menuaim.d.ts
vendored
Normal file
61
jquery.menuaim/jquery.menuaim.d.ts
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
/// <reference path="../jquery/jquery.d.ts" />
|
||||
|
||||
|
||||
interface JQueryMenuAimOptions {
|
||||
/** Function to call when a row is purposefully activated. Use this
|
||||
* to show a submenu's content for the activated row.
|
||||
*/
|
||||
activate? (): void;
|
||||
|
||||
/** Function to call when a row is deactivated.
|
||||
*/
|
||||
deactivate? (): void;
|
||||
|
||||
/** Function to call when mouse enters a menu row. Entering a row
|
||||
* does not mean the row has been activated, as the user may be
|
||||
* mousing over to a submenu.
|
||||
*/
|
||||
enter? (): void;
|
||||
|
||||
/** Function to call when mouse exits a menu row.
|
||||
*/
|
||||
exit? (): void;
|
||||
|
||||
/** Function to call when mouse exits the entire menu. If this returns
|
||||
* true, the current row's deactivation event and callback function
|
||||
* will be fired. Otherwise, if this isn't supplied or it returns
|
||||
* false, the currently activated row will stay activated when the
|
||||
* mouse leaves the menu entirely.
|
||||
*/
|
||||
exitMenu? (): void;
|
||||
|
||||
/** Selector for identifying which elements in the menu are rows
|
||||
* that can trigger the above events. Defaults to "> li".
|
||||
* rowSelector: "> li",
|
||||
*/
|
||||
rowSelector?: string;
|
||||
|
||||
/** You may have some menu rows that aren't submenus and therefore
|
||||
* shouldn't ever need to "activate." If so, filter submenu rows w/
|
||||
* this selector. Defaults to "*" (all elements).
|
||||
* submenuSelector: "*",
|
||||
*/
|
||||
submenuSelector?: string;
|
||||
|
||||
/** Direction the submenu opens relative to the main menu. This
|
||||
* controls which direction is "forgiving" as the user moves their
|
||||
* cursor from the main menu into the submenu. Can be one of "right",
|
||||
* "left", "above", or "below". Defaults to "right".
|
||||
* submenuDirection: "right"
|
||||
*/
|
||||
submenuDirection?: string;
|
||||
}
|
||||
|
||||
interface JQuery {
|
||||
/** Dropdown menus that can differentiate between a user trying hover over a dropdown item vs trying to navigate into a submenu's contents.
|
||||
* @author Ben Kamens
|
||||
* https://github.com/kamens/jQuery-menu-aim
|
||||
*/
|
||||
menuAim(options: JQueryMenuAimOptions): JQuery;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user